List contacts

List contacts

This endpoint will return a list of contacts from your workspace.

get

/workspaces/{workspaceId}/contacts

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidrequired

Your workspace identifier.

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

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return. The default value is 10, the minimum is one and the maximum is 100.

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list.

Example: nextPageToken123

reverseboolean

Order in which to retrieve the results.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.bird.com/workspaces/{workspaceId}/contacts' \
  --header 'Authorization: Bearer JWT'

200

404

200

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

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

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 your contacts

In this example, we're listing all contacts from a given workspace.

Request

curl -X GET "https://api.bird.com/workspaces/7d73f762-e08f-4e1f-a6fd-4d69d8cf119f/contacts" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcde" \

Response (200 OK)

{
  "results": [
    {
      "id": "12bd0e40-9361-4e32-8b26-99b4ab7eae09",
      "computedDisplayName": "",
      "identifierCount": 0,
      "attributes": {
        "initialReference": "32d6f4f9-7e9c-4271-bd83-9d6976808f2f",
        "timezone": "UTC"
      },
      "createdAt": "2024-11-26T15:00:00.000Z",
      "updatedAt": "2024-11-26T15:00:00.000Z"
    }
  ]
}