GET
/
conversations
/
{conversationId}
/
participants
curl --request GET \
  --url https://chat.botpress.cloud/{webhookUrl}/conversations/{conversationId}/participants \
  --header 'x-user-key: <x-user-key>'
{
  "participants": [
    {
      "id": "<string>",
      "name": "<string>",
      "pictureUrl": "<string>",
      "profile": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

Headers

​
x-user-key
string
required

Authentication Key

Path Parameters

​
conversationId
string
required

Conversation id

Query Parameters

​
nextToken
string

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

Response

200
application/json
Returns a list of [Participants](#schema_user) objects
​
participants
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