Documentation
Sign inGet started

Get a contact

GET
/v1/contacts/{contact_id}
curl -X GET "https://us1.platform.bird.com/v1/contacts/{contact_id}" \
  -H "Authorization: Bearer $TOKEN"
Returns a single contact by ID.
Parameter
contact_id
string
Contact ID.
Antwort-Payload
id
string
erforderlich
Contact ID.
email
string
erforderlich
The contact's email address, stored trimmed and lowercased. Unique within the workspace.
first_name
nullable string
The contact's first name.
last_name
nullable string
The contact's last name.
external_id
nullable string
Your own identifier for this contact, such as a user ID in your system. Unique within the workspace when set.
data
object
Custom property values for this contact, available as template variables in broadcasts. Each key is a property created via the contact properties API, and each value is a string, number, or boolean matching the property's declared type (strings up to 500 characters). Total size is capped at 2 KB serialized.
created_at
string
erforderlich
updated_at
string
erforderlich