Skip to main content

user

idnumber
access_tokenstring
account_idnumber
available_namestring
avatar_urlstring
confirmedboolean
display_namestring | nullnullable
message_signaturestring | nullnullable
emailstring
hmac_identifierstring
inviter_idnumber | nullnullable
namestring
providerstring
pubsub_tokenstring
rolestring

Possible values: [agent, administrator]

ui_settingsobject
uidstring
typestring | nullnullable
custom_attributesobject

Available for users who are created through platform APIs and has custom attributes associated.

accounts object[]
  • Array [
  • idnumber
    namestring
    statusstring
    active_at(string | null)<date-time>nullable
    rolestring

    Possible values: [administrator, agent]

    permissionsstring[]
    availabilitystring
    availability_statusstring
    auto_offlineboolean
    custom_role_idnumber | nullnullable
    custom_roleobject | nullnullable
  • ]
  • user
    {
    "id": 0,
    "access_token": "string",
    "account_id": 0,
    "available_name": "string",
    "avatar_url": "string",
    "confirmed": true,
    "display_name": "string",
    "message_signature": "string",
    "email": "string",
    "hmac_identifier": "string",
    "inviter_id": 0,
    "name": "string",
    "provider": "string",
    "pubsub_token": "string",
    "role": "agent",
    "ui_settings": {},
    "uid": "string",
    "type": "string",
    "custom_attributes": {},
    "accounts": [
    {
    "id": 0,
    "name": "string",
    "status": "string",
    "active_at": "2024-07-29T15:51:28.071Z",
    "role": "administrator",
    "permissions": [
    "string"
    ],
    "availability": "string",
    "availability_status": "string",
    "auto_offline": true,
    "custom_role_id": 0,
    "custom_role": "Unknown Type: object,null"
    }
    ]
    }