Get a contact

Get a contact

get

https://api.bird.comhttp://localhost:3000https://api.bird.ai

/workspaces/{workspaceId}/contacts/{contactId}

Get the specified contact given its ID.

Authorizations

MessageBird_userMessageBird_accessKey

AuthorizationstringRequired

An access token issued to a user.

Path parameters

workspaceIdstring · uuidRequired

Your workspace identifier.

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

contactIdstringRequired

The ID of a contact.

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

Query parameters

attributestring[]Optional

The set of attribute keys to return for the contact besides all non-empty attributes.

Example: ["age","company"]

Responses

200

Get the contact successfully.

application/json

404

The contact or workspace was not found.

application/json

422

The request is invalid. The response should include details about the what is wrong with the request.

application/json

get

/workspaces/{workspaceId}/contacts/{contactId}

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/contacts/{contactId} HTTP/1.1
Host: api.bird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "computedDisplayName": "John Doe",
  "createdAt": "2026-02-01T05:27:37.565Z",
  "updatedAt": "2026-02-01T05:27:37.565Z",
  "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"
  ],
  "companyRefs": [
    "text"
  ],
  "isAnonymous": true
}

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

Get a contact without specifying attributes

In this example, we're fetching the contact without specifying the attributes. To know more about attributes, please refer to this documentation.

Request

curl -X GET "https://api.bird.com/workspaces/7d73f762-e08f-4e1f-a6fd-4d69d8cf119f/contacts/12bd0e40-9361-4e32-8b26-99b4ab7eae09" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcde" \

Response (200 OK)

Get a contact specifying attributes

In this example, we are fetching the contact specifying the attributes. To know more about attributes, please refer to this documentation.

Request

curl -X GET "https://api.bird.com/workspaces/7d73f762-e08f-4e1f-a6fd-4d69d8cf119f/contacts/12bd0e40-9361-4e32-8b26-99b4ab7eae09?attribute=countryCode" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcde" \

Response (200 OK)