Texa DeskDevelopers

Texa Desk Application API · Profile

Fetch user profile

GET/api/v1/profile

Get the user profile details

Authorization

api_access_tokenheaderrequired

A person's access token (Texa Desk, Profile settings → Access token) or an agent bot's token, in the api_access_token header. It acts as that person, with their role's permissions.

Responses

200

Success

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

One of: agent, administrator.

ui_settingsobject
uidstring
typestring
custom_attributesobject

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

accountsarray of object
accounts[].idnumber
accounts[].namestring
accounts[].statusstring
accounts[].active_atstring (date-time)
accounts[].rolestring

One of: administrator, agent.

accounts[].permissionsarray of string
accounts[].availabilitystring
accounts[].availability_statusstring
accounts[].auto_offlineboolean
accounts[].custom_role_idnumber
accounts[].custom_roleobject
401

Unauthorized

descriptionstring
errorsarray of object
errors[].fieldstring
errors[].messagestring
errors[].codestring