List participant conversations by ID

Examples

Last updated 3 days ago

List participant conversations

Retrieve the conversations to a participant

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

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationParticipantId*string

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

Query parameters

Response

A list of conversations is returned

Body

results*array of Conversations_Conversation (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/participants/{conversationParticipantId}/conversations?channelId=123e4567-e89b-12d3-a456-426614174000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "results": [
    {
      "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-03T09:59:57.327Z"
      },
      "createdAt": "2024-12-03T09:59:57.327Z",
      "updatedAt": "2024-12-03T09:59:57.327Z",
      "platformStyle": "direct",
      "referral": {
        "sourceUrl": "text",
        "sourceId": "text",
        "sourceType": "text",
        "mediaUrl": "text",
        "mediaType": "text",
        "caption": "text",
        "title": "text",
        "text": "text",
        "username": "text",
        "timestamp": "2024-12-03T09:59:57.327Z"
      }
    }
  ],
  "nextPageToken": "text"
}

curl "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/participants/8f0b5377-2edc-4116-a8e8-6a475f245a04/conversations?channelId=7b0eb8a0-606b-59f1-bd90-43cacb048146" \
-H "Authorization: AccessKey abcd"

{
  "results": [
    {
      "id": "bace24af-cebb-4bd5-a1e6-f7cff24abadf",
      "name": "Re: About your refund request",
      "description": "",
      "status": "active",
      "visibility": "private",
      "accessibility": "open",
      "featuredParticipants": [
        {
          "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"
          }
        }
      ],
      "activeParticipantCount": 1,
      "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": "7b0eb8a0-606b-59f1-bd90-43cacb048146",
      "lastMessage": {
        "id": "0ff78529-eb64-400d-8522-c45ae2170885",
        "type": "html",
        "preview": {
          "text": "That's right 👍"
        },
        "recipients": null,
        "status": "delivered",
        "sender": {
          "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"
          }
        },
        "createdAt": "2024-11-27T14:47:59.577Z"
      },
      "createdAt": "2024-11-27T14:47:59.577Z",
      "updatedAt": "2024-11-27T14:47:59.577Z",
      "platformStyle": "email"
    }
  ]
}

List participant conversations

Retrieve the conversations to a participant

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

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationParticipantId*string

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

Query parameters

Response

A list of conversations is returned

Body

results*array of Conversations_Conversation (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/participants/{conversationParticipantId}/conversations?channelId=123e4567-e89b-12d3-a456-426614174000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "results": [
    {
      "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-03T09:59:57.327Z"
      },
      "createdAt": "2024-12-03T09:59:57.327Z",
      "updatedAt": "2024-12-03T09:59:57.327Z",
      "platformStyle": "direct",
      "referral": {
        "sourceUrl": "text",
        "sourceId": "text",
        "sourceType": "text",
        "mediaUrl": "text",
        "mediaType": "text",
        "caption": "text",
        "title": "text",
        "text": "text",
        "username": "text",
        "timestamp": "2024-12-03T09:59:57.327Z"
      }
    }
  ],
  "nextPageToken": "text"
}