Users

Get an user details

Get the details of an user

get/platform/api/v1/users/{id}

Request

Success

idnumber

access_tokenstring

account_idnumber

available_namestring

avatar_urlstring

confirmedboolean

display_namestring nullable

message_signaturestring nullable

emailstring

hmac_identifierstring

inviter_idnumber nullable

namestring

providerstring

pubsub_tokenstring

role'agent' | 'administrator'

ui_settingsobject

uidstring

typestring nullable

custom_attributesobject

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

Sep 23, 2026e0345067d3f1 Revision changes
- info
  the endpoint scheme security platformAppBearerAuth was added to the API
Mar 11, 20264237e34ddb40 Revision changes
- breaking
  the response property // became nullable for the status
- breaking
  the response property became nullable for the status