listParticipants

Retrieves a list of Participants for a given Conversation.

GET/conversations/{conversationId}/participants

Header parameters

x-user-keystringrequired

Authentication Key

Path parameters

conversationIdstringrequired

Conversation id

Query parameters

nextTokenstring

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

Response

application/json

Returns a list of Participants objects

The response is of type listParticipantsResponse · object.

participantsobject[]required

metaobjectrequired

Request

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

Response

{
  "participants": [
    {
      "id": "string",
      "name": "string",
      "pictureUrl": "string",
      "profile": "string",
      "createdAt": "2025-01-15T12:00:00Z",
      "updatedAt": "2025-01-15T12:00:00Z"
    }
  ],
  "meta": {
    "nextToken": "string"
  }
}