List contacts
This endpoint will return a list of contacts from your workspace.
Authorizations
Path parameters
workspaceIdstring · uuidRequiredExample:
Your workspace identifier.
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 contacts was returned. The list can be empty if no contacts are found.
application/json
Responseall of
404
The workspace was not found.
application/json
get
GET /workspaces/{workspaceId}/contacts HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Accept: */*
{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"computedDisplayName": "John Doe",
"createdAt": "2025-08-19T19:54:53.663Z",
"updatedAt": "2025-08-19T19:54:53.663Z",
"workspaceId": "123e4567-e89b-12d3-a456-426614174000",
"featuredIdentifiers": [
{
"key": "emailaddress",
"value": "[email protected]"
}
],
"attributes": {
"firstName": "John",
"lastName": "Smith",
"rating": 9.6,
"cookiesAccepted": false,
"labels": [
"A",
"B",
"C"
]
},
"identifierCount": 2,
"accountIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"listIds": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"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
List your contacts
In this example, we're listing all contacts from a given workspace.
curl -X GET "https://api.bird.com/workspaces/7d73f762-e08f-4e1f-a6fd-4d69d8cf119f/contacts" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcde" \
Last updated
Was this helpful?