Get conversation
Last updated
Was this helpful?
Last updated
Was this helpful?
curl "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/02ec2ac2-ebec-42d3-a5f4-e6f3a9edf418" \
-H "Authorization: AccessKey abcd"{
"id": "907798f8-fd72-44d5-8042-fcc05c1bb570",
"name": "test",
"description": "",
"status": "active",
"visibility": "public",
"accessibility": "open",
"featuredParticipants": [
{
"id": "8f0b5377-2edc-4116-a8e8-6a475f245a04",
"type": "contact",
"status": "active",
"displayName": "Lucas De Mitri",
"avatarUrl": "",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "john.doe@bird.com",
"platformAddress": "john.doe@bird.com"
}
},
{
"id": "68b80b8d-8060-42df-bda3-73505a8fdb84",
"type": "accessKey",
"status": "active",
"displayName": "My first email key",
"avatarUrl": ""
}
],
"activeParticipantCount": 2,
"pendingParticipantCount": 0,
"initiatingParticipant": {
"id": "8f0b5377-2edc-4116-a8e8-6a475f245a04",
"type": "contact",
"status": "active",
"displayName": "John Doe",
"avatarUrl": "",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "john.doe@bird.com",
"platformAddress": "john.doe@bird.com"
}
},
"channelId": "cb4b1ebc-34e6-5a7a-a375-f6f2f131d88f",
"lastMessage": {
"id": "d578f436-b3b7-49e6-95c2-24b77bb4e7ce",
"type": "text",
"preview": {
"text": "Hey, listen!"
},
"recipients": [
{
"type": "to",
"id": "8f0b5377-2edc-4116-a8e8-6a475f245a04",
"identifierKey": "emailaddress",
"identifierValue": "john.doe@bird.com",
"platformAddress": "john.doe@bird.com",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"status": "delivered",
"sender": {
"id": "68b80b8d-8060-42df-bda3-73505a8fdb84",
"type": "accessKey",
"status": "active",
"displayName": "My first email key",
"avatarUrl": ""
},
"createdAt": "2024-11-29T13:22:22.875Z"
},
"createdAt": "2024-11-25T19:31:47.264Z",
"updatedAt": "2024-11-29T13:31:03.845Z",
"platformStyle": "email"
}Get a single conversation
The workspace ID
b4e02c85-c6d2-4b15-8885-e09671799c61The conversation ID
67e4d358-ca94-421e-98b7-448860df9d33A conversation object.
GET /workspaces/{workspaceId}/conversations/{conversationId} HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Accept: */*
{
"id": "299227f5-1c61-4341-ad50-efed5c048998",
"name": "Re: Your refund request",
"description": "Refund request ticket",
"status": "active",
"visibility": "public",
"accessibility": "open",
"style": "default",
"featuredParticipants": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
}
],
"initiatingParticipant": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"activeParticipantCount": 2,
"pendingParticipantCount": 1,
"channelId": "ab651378-579a-4491-abe6-eec97d4c0fa3",
"lastMessage": {
"id": "69e97125-ddd4-4042-9d58-8350e806e1de",
"type": "text",
"preview": {
"text": "Thank you for reaching out, could you please inform your account number?"
},
"status": "accepted",
"sender": {
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"displayName": "John Doe",
"avatarUrl": "https://example.bird.com/avatar-url",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "example@bird.com",
"platformAddressSelector": "attributes.workEmail"
},
"type": "user",
"status": "pending"
},
"recipients": [
{
"id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
"type": "to",
"identifierKey": "emailaddress",
"identifierValue": "example@bird.com",
"platformAddress": "text",
"platformAddressSelector": "attributes.workEmail",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"createdAt": "2024-01-01T00:00:00.123Z"
},
"createdAt": "2024-01-01T00:00:00.123Z",
"updatedAt": "2024-01-01T00:00:00.123Z",
"platformStyle": "direct",
"attributes": {
"myCustomField": "abc"
},
"referral": {
"sourceUrl": "https://instagram.com/p/EXAMPLEID",
"sourceId": "120211000000000000",
"sourceType": "AD",
"mediaUrl": "https://cdninstagram.com/v/example",
"mediaType": "IMAGE",
"caption": "Introducing Dream Summer Days Daily SPF, your go-to sunscreen for safeguarding your skin's glow under the sun's embrace.",
"title": "Dream Summer Days Daily SPF",
"text": "Crafted with broad-spectrum SPF 50+ protection, Dream Summer Days Daily SPF offers reliable defense against both UVA and UVB rays",
"username": "DreamCosmetics",
"timestamp": "2024-11-28T12:00:00.000Z"
},
"likelySpam": true,
"likelySpamReason": "advertisement",
"resource": {
"type": "task",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
}