List contacts in a list

Last updated 2 months ago

Was this helpful?

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.

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"

{
  "results": [
    {
      "id": "12bd0e40-9361-4e32-8b26-99b4ab7eae09",
      "computedDisplayName": "John",
      "featuredIdentifiers": [
        {
          "key": "emailaddress",
          "value": "contacts@bird.com"
        }
      ],
      "identifierCount": 1,
      "attributes": {
        "emailaddress": [
          "contacts@bird.com"
        ],
        "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"
    }
  ]
}