listParticipants

Retrieves a list of Participants for a given Conversation.

GET /conversations/{conversationId}/participants

List Participants

cURL

curl --request GET \
  --url https://chat.botpress.cloud/{webhookUrl}/conversations/{conversationId}/participants \
  --header 'x-user-key: <x-user-key>'

200

{
  "participants": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "pictureUrl": "<string>",
      "profile": "<string>"
    }
  ],
  "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 objects

participants · object[] · required

Show child attributes

meta · object · required

Show child attributes