Get participant by ID

Get conversation participant

get

Retrieve a single conversation participant

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

conversationParticipantIdstring · min: 1required

The ID that refers to the conversation participant (e.g. the contact ID if the participant is a contact)

Example: 274bd6ff-3295-49a0-a02d-651fb661d7fb

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "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": "pending"
}

OK

Examples

Request

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

Response (200 - OK)

{
  "id": "8f0b5377-2edc-4116-a8e8-6a475f245a04",
  "type": "contact",
  "status": "active",
  "displayName": "John Doe",
  "avatarUrl": "",
  "contact": {
    "identifierKey": "emailaddress",
    "identifierValue": "[e-mail]",
    "platformAddress": "[e-mail]"
  }
}