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, including its custom data values and the channels it can be reached on. To find a contact's ID by email address or external_id, use List contacts.
Parametry
contact_id
string
ID of the contact to fetch (con_-prefixed).
Treść odpowiedzi
id
string
wymagane
ID of the contact (con_-prefixed), accepted by every operation that takes a contact_id.
email
string
wymagane
The contact's email address, stored trimmed and lowercased. Unique within the workspace.
first_name
nullable string
The contact's first name. Available in broadcast templates as the contact.first_name variable.
last_name
nullable string
The contact's last name. Available in broadcast templates as the contact.last_name variable.
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. Values stored under a property that was later archived remain readable here.
channels
array of string
Channels this contact can be reached on, derived from the identifiers it has. A contact with an email address includes email. More values are added as a contact gains identifiers for other channels.
created_at
string
wymagane
updated_at
string
wymagane