List participants
Retrieve the list of participants in a conversation
Authorizations
Path parameters
workspaceIdstring · uuidRequiredExample:
The workspace ID
b4e02c85-c6d2-4b15-8885-e09671799c61
conversationIdstring · uuidRequiredExample:
The conversation ID
67e4d358-ca94-421e-98b7-448860df9d33
Query parameters
limitinteger · min: 1 · max: 100OptionalDefault:
Limits the number of results to return
10
Example: 10
pageTokenstring · max: 8000OptionalExample:
Pagination token that keeps of track of the current position in the list
WyIyMDI0LTExLTE1VDEzOjM0OjQ1Ljc3NTYzMDE0OVoiLCJhMGEwM2IxOS03NTQ5LTRlZmUtOTBjZS1jNzdlYzI0ZjZmN2YiXQ==
reversebooleanOptionalDefault:
Order in which to retrieve the results
false
Responses
200
A list of participants is returned
application/json
Responseall of
404
The resource specified in the URL was not found
application/json
get
GET /workspaces/{workspaceId}/conversations/{conversationId}/participants HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Accept: */*
{
"results": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "[email protected]",
"platformAddress": "[email protected]",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "active"
}
],
"nextPageToken": "WyIyMDI0LTExLTE1VDEzOjM0OjQ1Ljc3NTYzMDE0OVoiLCJhMGEwM2IxOS03NTQ5LTRlZmUtOTBjZS1jNzdlYzI0ZjZmN2YiXQ==",
"total": 1,
"totalType": ""
}
Examples
curl "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/02ec2ac2-ebec-42d3-a5f4-e6f3a9edf418/participants" \
-H "Authorization: AccessKey abcd"
Last updated
Was this helpful?