listUsers

Retrieves a list of User previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using Tags.

GET /v1/chat/users

Try it

cURL

cURL

curl --request GET \
  --url https://api.botpress.cloud/v1/chat/users \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <x-bot-id>'

200

{
  "users": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "tags": {},
      "name": "<string>",
      "pictureUrl": "<string>"
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

Query Parameters

nextToken · string

Provide the meta.nextToken value provided in the last API response to retrieve the next page of results

conversationId · string

Filter by conversation id. This will return all users that have participated in the conversation.

tags · object

Filter by tags

Show child attributes

tags. {key} · string

Response

200

application/json

Returns a list of User objects

users · object[] · required

Show child attributes

users. id · string · required

Id of the User

Required string length: 28 - 36

users. createdAt · string<date-time> · required

Creation date of the User in ISO 8601 format

users. updatedAt · string<date-time> · required

Updating date of the User in ISO 8601 format

users. tags · object · required

Set of Tags that you can attach to a User. The set of Tags available on a User is restricted by the list of Tags defined previously by the Bot. Individual keys can be unset by posting an empty value to them.

Show child attributes

users.tags. {key} · string

users. name · string

Name of the User

Maximum string length: 200

users. pictureUrl · string

Picture URL of the User

Maximum string length: 40000

meta · object · required

Show child attributes

meta. nextToken · string

The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.