List participants

List conversation participants

Retrieve the list of participants in a conversation

get

/workspaces/{workspaceId}/conversations/{conversationId}/participants

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidrequired

The workspace ID

Example: b4e02c85-c6d2-4b15-8885-e09671799c61

conversationIdstring · uuidrequired

The conversation ID

Example: 67e4d358-ca94-421e-98b7-448860df9d33

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

Example: 10

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

Example: WyIyMDI0LTExLTE1VDEzOjM0OjQ1Ljc3NTYzMDE0OVoiLCJhMGEwM2IxOS03NTQ5LTRlZmUtOTBjZS1jNzdlYzI0ZjZmN2YiXQ==

reverseboolean

Order in which to retrieve the results

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/participants' \
  --header 'Authorization: Bearer JWT'

200

404

200

{
  "results": [
    {
      "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
      "displayName": "John Doe",
      "avatarUrl": "https://example.bird.com/avatar-url",
      "contact": {
        "identifierKey": "emailaddress",
        "identifierValue": "[e-mail]",
        "platformAddress": "[e-mail]",
        "platformAddressSelector": "attributes.workEmail"
      },
      "type": "user",
      "status": "active"
    }
  ],
  "nextPageToken": "WyIyMDI0LTExLTE1VDEzOjM0OjQ1Ljc3NTYzMDE0OVoiLCJhMGEwM2IxOS03NTQ5LTRlZmUtOTBjZS1jNzdlYzI0ZjZmN2YiXQ=="
}

A list of participants is returned

Examples

Request

curl "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/02ec2ac2-ebec-42d3-a5f4-e6f3a9edf418/participants" \
-H "Authorization: AccessKey abcd"

Response (200 - OK)

{
  "results": [
    {
      "id": "68b80b8d-8060-42df-bda3-73505a8fdb84",
      "type": "accessKey",
      "status": "active",
      "displayName": "My first email key",
      "avatarUrl": ""
    },
    {
      "id": "8f0b5377-2edc-4116-a8e8-6a475f245a04",
      "type": "contact",
      "status": "active",
      "displayName": "John Doe",
      "avatarUrl": "",
      "contact": {
        "identifierKey": "emailaddress",
        "identifierValue": "[e-mail]",
        "platformAddress": "[e-mail]"
      }
    }
  ]
}