Get user details

Retrieve all details of a specific user. To fetch specifc custom or system user properties, use the properties param.

Path Parameters
userId string — REQUIRED The unique identifier for the user.

Query Parameters
bot string — REQUIRED The unique identifier for the bot.
allProperties string Pass true to fetch all user properties; else, set false.
properties string-enum Use to fetch specific system or custom user properties. A comma-separated list of user properties to fetch. Leave empty to fetch all properties.
userId string Possible values: [yes, no] Whether to include the userId field in the response. Defaults to yes.

Responses
200 User properties fetched successfully. Schema — OPTIONAL message string — OPTIONAL data object — OPTIONAL
400 Bad request. Invalid parameters provided. Schema — OPTIONAL error string — OPTIONAL
401 Unauthorized. Invalid or missing API key. Schema — OPTIONAL error string — OPTIONAL
500 Internal server error. Schema — OPTIONAL error string — OPTIONAL