Get conversation

Get conversation

Get a single conversation

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

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationId*any of

The conversation ID

enumstring (uuid)

Response

200404

The conversation was found

Body

application/json

id*string

name*string

descriptionstring

status*enum

activeclosed

visibility*enum

publicprivate

accessibility*enum

openinvite-onlyrequest-to-join

featuredParticipants*array of ConversationParticipant

initiatingParticipantConversationParticipant

activeParticipantCount*integer

pendingParticipantCountinteger

channelId*string (uuid)

lastMessageConversations_LastMessage (object)

createdAt*string (date-time)

updatedAt*string (date-time)

platformStyle*enum

directemaildirect-multiple

attributesnullable object

referralnullable Conversations_Referral (object)

Request

JavaScriptCurlPython

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

Response

200404

{
  "id": "text",
  "name": "text",
  "description": "text",
  "status": "active",
  "visibility": "public",
  "accessibility": "open",
  "featuredParticipants": [
    {
      "id": "text",
      "displayName": "text",
      "avatarUrl": "text",
      "contact": {
        "identifierKey": "text",
        "identifierValue": "text",
        "platformAddress": "text",
        "platformAddressSelector": "text"
      },
      "type": "user",
      "status": "pending"
    }
  ],
  "initiatingParticipant": {
    "id": "text",
    "displayName": "text",
    "avatarUrl": "text",
    "contact": {
      "identifierKey": "text",
      "identifierValue": "text",
      "platformAddress": "text",
      "platformAddressSelector": "text"
    },
    "type": "user",
    "status": "pending"
  },
  "activeParticipantCount": 0,
  "pendingParticipantCount": 0,
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "lastMessage": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "preview": {
      "text": "text"
    },
    "status": "accepted",
    "sender": {
      "id": "text",
      "displayName": "text",
      "avatarUrl": "text",
      "contact": {
        "identifierKey": "text",
        "identifierValue": "text",
        "platformAddress": "text",
        "platformAddressSelector": "text"
      },
      "type": "user",
      "status": "pending"
    },
    "recipients": [
      {
        "id": "text",
        "type": "to",
        "identifierKey": "text",
        "identifierValue": "text",
        "platformAddress": "text",
        "platformAddressSelector": "text",
        "contactAnnotation": {
          "name": "text"
        }
      }
    ],
    "createdAt": "2024-12-03T14:04:59.203Z"
  },
  "createdAt": "2024-12-03T14:04:59.203Z",
  "updatedAt": "2024-12-03T14:04:59.203Z",
  "platformStyle": "direct",
  "referral": {
    "sourceUrl": "text",
    "sourceId": "text",
    "sourceType": "text",
    "mediaUrl": "text",
    "mediaType": "text",
    "caption": "text",
    "title": "text",
    "text": "text",
    "username": "text",
    "timestamp": "2024-12-03T14:04:59.203Z"
  }
}

Examples

Request

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

Response (200 - OK)

{
  "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": "[e-mail]",
        "platformAddress": "[e-mail]"
      }
    },
    {
      "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": "[e-mail]",
      "platformAddress": "[e-mail]"
    }
  },
  "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": "[e-mail]",
        "platformAddress": "[e-mail]",
        "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"
}