Contacts
Contacts represent individuals who interact with your team. Manage customer profiles, custom attributes, and conversation history.
GET/api/v1/accounts/{account_id}/contacts
Retrieve a paginated list of all contacts in your account.
Query Parameters
| pageinteger | Page number (default: 1, 15 per page) |
| sortstring | Sort field: name, email, phone_number, last_activity_at, created_at |
| order_bystring | asc or desc |
POST/api/v1/accounts/{account_id}/contacts
Create a new contact in your account.
Body Parameters
| namestring | Contact's full name |
| emailstring | Contact's email address |
| phone_numberstring | Contact's phone number (E.164 format) |
| avatar_urlstring | URL to the contact's avatar image |
| identifierstring | Unique external identifier for the contact |
| custom_attributesobject | Key-value pairs of custom attributes |
GET/api/v1/accounts/{account_id}/contacts/{id}
Retrieve a single contact by ID, including all profile data and custom attributes.
PATCH/api/v1/accounts/{account_id}/contacts/{id}
Update contact profile information, custom attributes, or avatar.
DELETE/api/v1/accounts/{account_id}/contacts/{id}
Permanently delete a contact and all associated data. This action cannot be undone.
GET/api/v1/accounts/{account_id}/contacts/{id}/conversations
Retrieve all conversations associated with a specific contact.
GET/api/v1/accounts/{account_id}/search?q={query}
Search contacts by name, email, phone number, or identifier.
Query Parameters
| qstringrequired | Search query string |
| pageinteger | Page number |