Skip to main content

Get user details

Retrieves the details of a specific user based on the userId provided.

Path Parameters
userId string REQUIRED

The unique ID of the user.

Query Parameters
bot string REQUIRED

The unique bot ID in which the user record is available.

allProperties string

Pass true to retrieve all user properties. By default, only a few standard properties firstName, lastName

Responses
200

OK

Schema OPTIONAL
contactDetails object OPTIONAL

Details of the created contact

400

Bad Request

Schema OPTIONAL
error string OPTIONAL

Error details

401

Unauthorized request or invalid X-Auth-Token or botId

406

Not Acceptable

500

Internal Server Error

Schema OPTIONAL
error string OPTIONAL

Error details