Get participant by ID

Get conversation participant

Retrieve a single conversation participant

GEThttps://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationId*any of

The conversation ID

enumstring (uuid)

conversationParticipantId*string

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

Response

200404

OK

Body

application/json

id*string

displayNamestring

avatarUrlstring

contactConversationParticipantContact

anyany

type*Conversations_ParticipantType (enum)

usercontactflowbotaccessKeychannelconnectorcollaborationAutomation

statusenum

pendinginvitedactive

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": "text",
  "displayName": "text",
  "avatarUrl": "text",
  "contact": {
    "identifierKey": "text",
    "identifierValue": "text",
    "platformAddress": "text",
    "platformAddressSelector": "text"
  },
  "type": "user",
  "status": "pending"
}

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]"
  }
}