GET
/
v1
/
chat
/
users
curl --request GET \
  --url https://api.botpress.cloud/v1/chat/users
{
  "users": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "tags": {},
      "name": "<string>",
      "pictureUrl": "<string>"
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

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](#schema_user) objects
​
users
object[]
required

The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.

​
meta
object
required

Was this page helpful?

Suggest editsRaise issue