Contacts

The contact database: people, tags, custom fields and notes.

The contact object

As returned by GET /contacts, one element of the list. Every endpoint below that returns this resource returns exactly these fields.

Name	Type	Description
`id`required	`string (uuid)`	UUID
`name`required	`string \| null`	Display name
`phone`required	`string \| null`	E.164 phone number, or null for a contact reached only on Messenger/Instagram/web chat
`email`required	`string \| null`	Email address, when one is known
`company`required	`string \| null`	Company or organisation the contact belongs to
`avatar_url`required	`string \| null`	Profile picture URL, when a channel supplied one
`tags`required	`object[]`	Tags applied to this contact
`tags[].id`required	`string (uuid)`	UUID
`tags[].name`required	`string`	Tag name
`tags[].color`required	`string`	Hex colour chosen in the dashboard
`custom_fields`required	`object[]`	Custom-field values set on this contact
`custom_fields[].field_id`required	`string (uuid)`	The custom field definition
`custom_fields[].name`required	`string`	Field name as shown in the dashboard
`custom_fields[].value`required	`string \| null`	The value for this contact
`created_at`required	`string (date-time)`	ISO 8601 timestamp
`updated_at`required	`string (date-time)`	ISO 8601 timestamp

12 endpoints, each on its own page with its parameters, responses, error codes and samples in curl, Node and Python.