List contact identifiers

List contact identifiers

get

https://api.bird.comhttp://localhost:3000https://api.bird.ai

/workspaces/{workspaceId}/contacts/{contactId}/identifiers

This endpoint will return a list of identifiers for the specified contact.

Authorizations

MessageBird_userMessageBird_accessKey

AuthorizationstringRequired

An access token issued to a user.

Path parameters

workspaceIdstring · uuidRequired

Your workspace identifier.

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

contactIdstringRequired

The ID of a contact.

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

Query parameters

limitinteger · min: 1 · max: 100Optional

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

Default: 10

pageTokenstring · max: 8000Optional

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

Example: nextPageToken123

reversebooleanOptional

Order in which to retrieve the results.

Default: false

Responses

200

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

application/json

nextPageTokenstringOptional

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

404

The contact or workspace was not found.

application/json

get

/workspaces/{workspaceId}/contacts/{contactId}/identifiers

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/contacts/{contactId}/identifiers HTTP/1.1
Host: api.bird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "results": [
    {
      "contactId": "123e4567-e89b-12d3-a456-426614174000",
      "key": "secondaryEmailAddress",
      "value": "[email protected]",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "createdAt": "2026-04-02T09:21:52.745Z"
    }
  ],
  "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

• Contact ID: 12bd0e40-9361-4e32-8b26-99b4ab7eae09

List the identifiers from a contact

In this example, we're listing contact identifiers from a given contact ID.

Request

curl -X GET "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/contacts/12bd0e40-9361-4e32-8b26-99b4ab7eae09/identifiers" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \

Response (200 OK)