Get a contact

Get a contact

get

Get the specified contact given its ID.

Authorizations

MessageBird_userMessageBird_accessKey

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

application/json

objectOptional

application/json

application/json

get

HTTPcURLJavaScriptPython

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "computedDisplayName": "John Doe",
  "createdAt": "2025-04-19T00:22:15.532Z",
  "updatedAt": "2025-04-19T00:22:15.532Z",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "featuredIdentifiers": [
    {
      "key": "emailaddress",
      "value": "[e-mail]"
    }
  ],
  "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

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)

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

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)

{
  "id": "12bd0e40-9361-4e32-8b26-99b4ab7eae09",
  "computedDisplayName": "John",
  "featuredIdentifiers": [
    {
      "key": "emailaddress",
      "value": "[e-mail]"
    }
  ],
  "identifierCount": 1,
  "attributes": {
    "emailaddress": [
      "[e-mail]"
    ],
    "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"
}