List contacts in a list

List contacts in a list.

This endpoint will return a list of contacts in the specified list.

GEThttps://api.bird.com/workspaces/{workspaceId}/lists/{listId}/contacts

Path parameters

workspaceId*string (uuid)

Your workspace identifier.

Example: "b4e02c85-c6d2-4b15-8885-e09671799c61"

listId*string (uuid)

The ID of a list.

Example: "b4e02c85-c6d2-4b15-8885-e09671799c61"

Query parameters

Response

200404

A list of contacts was returned. The list can be empty if no contacts are found.

Body

application/json

results*array of Contacts_Contact (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

JavaScriptCurlPython

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

Response

200404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "computedDisplayName": "John Doe",
      "createdAt": "2024-12-03T15:19:28.998Z",
      "updatedAt": "2024-12-03T15:19:28.998Z",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "featuredIdentifiers": [
        {
          "key": "emailaddress",
          "value": "[e-mail]"
        }
      ],
      "attributes": {
        "firstName": "John",
        "lastName": "Smith",
        "rating": 9.6,
        "cookiesAccepted": false,
        "labels": [
          "A",
          "B",
          "C"
        ]
      },
      "identifierCount": 2,
      "accountIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "listIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "nextPageToken": "text"
}

Examples

Let's establish some of our data that will be used in the following examples:

• Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352

• AccessKey: abcd

• List ID: 123e4567-e89b-12d3-a456-426614174000

List contacts from a list

In this example, we are listing all the contacts from a list given given the list ID.

Request

curl -X GET "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/lists/123e4567-e89b-12d3-a456-426614174000/contacts" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd"

Response (200 OK)

{
  "results": [
    {
      "id": "12bd0e40-9361-4e32-8b26-99b4ab7eae09",
      "computedDisplayName": "John",
      "featuredIdentifiers": [
        {
          "key": "emailaddress",
          "value": "[e-mail]"
        }
      ],
      "identifierCount": 1,
      "attributes": {
        "emailaddress": [
          "[e-mail]"
        ],
        "firstName": "John",
        "initialReference": "32d6f4f9-7e9c-4271-bd83-9d6976808f2f",
        "lastName": "Doe",
        "timezone": "America/Sao_Paulo"
      },
      "listIds": [
        "12bd0e40-9361-4e32-8b26-99b4ab7eae09"
      ],
      "createdAt": "2024-11-26T15:00:00.000Z",
      "updatedAt": "2024-11-26T15:00:00.000Z"
    }
  ]
}