Skip to main content
GET
Gets the Current User's Profile

Authorizations

X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

Accept
enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

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

Response

Current user Contact Profile retrieved.

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}$
cxoneTenantId
string

ID of the CXone tenant the user's organisation is linked to. Omitted when the organisation is not linked to CXone.

cxoneBusinessUnitId
string

ID of the CXone business unit (BUID) configured for the user's organisation. Omitted when no business unit is configured.