List contact identifiers

List contact identifiers

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

get

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

Authorizations

MessageBird_userMessageBird_accessKey

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: 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/{contactId}/identifiers' \
  --header 'Authorization: Bearer JWT'

200

404

200

{
  "results": [
    {
      "contactId": "123e4567-e89b-12d3-a456-426614174000",
      "key": "secondaryEmailAddress",
      "value": "[e-mail]",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "createdAt": "2025-02-21T18:01:30.109Z"
    }
  ],
  "nextPageToken": "text"
}

A list of identifiers was returned. The list can be empty if no identifiers 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

• 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)

{
  "results": [
    {
      "contactId": "12bd0e40-9361-4e32-8b26-99b4ab7eae09",
      "key": "emailaddress",
      "value": "[e-mail]",
      "properties": {
        "isGmail": true
      },
      "createdAt": "2024-11-26T15:00:00.000Z"
    }
  ]
}