Get a contact
GET
/v1/contacts/{contact_id}
const contact = await bird.contacts.get("con_01krdgeqcxet5s7t44vh8rt9mg");
console.log(contact.email, contact.first_name);contact = client.contacts.get("con_01krdgeqcxet5s7t44vh8rt9mg")
print(contact.email)contact, err := client.Contacts.Get(context.Background(), "con_123")
if err != nil {
log.Fatal(err)
}
fmt.Println(contact.Email)$contact = $bird->contacts->get('con_01krdgeqcxet5s7t44vh8rt9mg');
echo $contact->getEmail(), ' ', $contact->getFirstName();bird contacts get <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.
Parâmetros
contact_id
string
ID of the contact to fetch (con_-prefixed).
Payload de resposta
id
string
obrigatório
ID of the contact (con_-prefixed), accepted by every operation that takes a contact_id.
email
nullable string
obrigatório
The contact's email address, in its stored form, trimmed and lowercased before uniqueness is checked. Unique within the workspace. Null when the contact has no email address.
phone_number
nullable string
obrigatório
The contact's phone number in normalized international form (a leading + and four to 15 digits), which may differ from the form it was supplied in. Bird normalizes formatting but does not verify the number against numbering-plan metadata. Unique within the workspace. Carriers recycle disconnected numbers, so a long-stored number can come to belong to someone else; external_id is the durable key for your own records. Null when the contact has no phone number.
first_name
nullable string
The contact's first name. Available in broadcast templates as bird.contact.first_name.
last_name
nullable string
The contact's last name. Available in broadcast templates as bird.contact.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 in broadcast templates as bird.contact.<key>. Each key is a property created via the contact properties API, and each value is a string, number, boolean, or RFC 3339 datetime 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.
audiences
array of object
The audiences this contact belongs to, most-recently-joined first. Only present when listing contacts; omitted from every other contact operation.
Mostrar atributos secundários
audiences.id
string
obrigatório
ID of the referenced audience (adn_-prefixed).
audiences.name
string
obrigatório
The audience's display name.
created_at
string
obrigatório
updated_at
string
obrigatório