Search contact by identifier
Search for contacts
Authorizations
Path parameters
workspaceIdstring · uuidRequiredExample:
Your workspace identifier.
b4e02c85-c6d2-4b15-8885-e09671799c61
Body
platformAddressstringOptional
Responses
200
OK
application/json
Responseall of
post
POST /workspaces/{workspaceId}/contacts/search HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 69
{
"identifier": {
"key": "text",
"value": "text"
},
"platformAddress": "text"
}
200
OK
{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"computedDisplayName": "John Doe",
"createdAt": "2025-07-12T05:56:00.214Z",
"updatedAt": "2025-07-12T05:56:00.214Z",
"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"
]
}
]
}
Examples
curl -X GET "https://api.bird.com/workspaces/7d73f762-e08f-4e1f-a6fd-4d69d8cf119f/contacts/search" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcde" \
-d '{
"identifier": {
"key": "emailaddress",
"value": "[email protected]"
}
}'
Last updated
Was this helpful?