List contact identifiers
This endpoint will return a list of identifiers for the specified contact.
Authorizations
Path parameters
workspaceIdstring · uuidRequiredExample:
Your workspace identifier.
b4e02c85-c6d2-4b15-8885-e09671799c61
contactIdstringRequiredExample:
The ID of a contact.
b4e02c85-c6d2-4b15-8885-e09671799c61
Query parameters
limitinteger · min: 1 · max: 100OptionalDefault:
Limits the number of results to return. The default value is 10, the minimum is one and the maximum is 100.
10
pageTokenstring · max: 8000OptionalExample:
Pagination token that keeps of track of the current position in the list.
nextPageToken123
reversebooleanOptionalDefault:
Order in which to retrieve the results.
false
Responses
200
A list of identifiers was returned. The list can be empty if no identifiers are found.
application/json
Responseall of
404
The contact or workspace was not found.
application/json
get
GET /workspaces/{workspaceId}/contacts/{contactId}/identifiers HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Accept: */*
{
"results": [
{
"contactId": "123e4567-e89b-12d3-a456-426614174000",
"key": "secondaryEmailAddress",
"value": "[email protected]",
"properties": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"createdAt": "2025-06-30T18:03:44.185Z"
}
],
"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.
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" \
Last updated
Was this helpful?