GET
/
v1
/
chat
/
users
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/chat/users \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <api-key>'
{
  "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.

​
x-bot-id
string
header
required

Your bot ID.

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

Response

200
application/json

Returns a list of User objects

The response is of type object.