Skip to main content
GET
/
v2.0
/
users
/
{userId}
Get a User
curl --request GET \
  --url 'https://api-trial.cognigy.ai/new/v2.0/users/{userId}?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "organisation": "<string>",
  "roles": [
    "admin"
  ],
  "projects": [
    "<string>"
  ],
  "acceptedTOS": true,
  "disabled": true,
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
api_key
string
query
required

Supply the API Key in the Url-Query

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
userId
string
required

The Id of the User

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Response

Returns User object

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

​
id
string
​
name
string
​
organisation
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
roles
enum<string>[]
Available options:
admin,
apiKeys,
base_role,
basicSupportUser,
fullSupportUser,
liveAgentAdmin,
liveAgentAgent,
liveAgentSupervisor,
odata,
projectAssigner,
projectManager,
userManager,
userDetailsViewer,
voiceGatewayUser,
opsCenterUser
​
projects
string[]
​
acceptedTOS
boolean
​
disabled
boolean
​
_id
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
createdBy
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
lastChangedBy
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$