List contact identifiers

List contact identifiers

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

GEThttps://api.bird.com/workspaces/{workspaceId}/contacts/{contactId}/identifiers

Path parameters

workspaceId*string (uuid)

Your workspace identifier.

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

contactId*string

The ID of a contact.

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

Query parameters

Response

200404

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

Body

application/json

results*array of Contacts_Identifier (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}/contacts/{contactId}/identifiers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "contactId": "123e4567-e89b-12d3-a456-426614174000",
      "key": "secondaryEmailAddress",
      "value": "[e-mail]",
      "createdAt": "2024-12-03T14:57:46.198Z"
    }
  ],
  "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)

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