Search contact by identifier

Search Contacts

post

Search for contacts

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidRequired

Your workspace identifier.

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

Body

platformAddressstringOptional

Responses

200

OK

application/json

Responseall of

post

HTTPcURLJavaScriptPython

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-12T01:15:59.178Z",
      "updatedAt": "2025-07-12T01:15:59.178Z",
      "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

Request

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]"
  }
}'

Response (200 OK)

{
  "results": [
    {
      "id": "12bd0e40-9361-4e32-8b26-99b4ab7eae09",
      "computedDisplayName": "John",
      "featuredIdentifiers": [
        {
          "key": "emailaddress",
          "value": "[email protected]"
        }
      ],
      "identifierCount": 1,
      "attributes": {
        "emailaddress": [
          "[email protected]"
        ],
        "firstName": "John",
        "initialReference": "32d6f4f9-7e9c-4271-bd83-9d6976808f2f",
        "lastName": "Doe",
        "timezone": "America/Sao_Paulo",
        "countryCode": null
      },
      "listIds": [
        "12bd0e40-9361-4e32-8b26-99b4ab7eae09"
      ],
      "createdAt": "2024-11-26T15:00:00.000Z",
      "updatedAt": "2024-11-26T15:00:00.000Z"
    }
  ]
}