Retrieve a list of contacts with filtering options
Retrieve a paginated list of contacts with various filtering options.
This endpoint requires an API key with the can_read_contacts
permission.
Parameter | Type | Required | Description |
---|---|---|---|
stage | string | No | Filter by contact stage (lead, prospect, customer, etc.) |
status | string | No | Filter by contact status (not_contacted, contacted, etc.) |
tag | string | No | Filter by tag name |
search | string | No | Search in first name, last name, and email |
page | integer | No | Page number for pagination (default: 1) |
limit | integer | No | Number of results per page (default: 25, max: 100) |
Status Code | Error Code | Description |
---|---|---|
401 | authentication_required | No API key was provided |
401 | invalid_key | The API key is invalid or inactive |
403 | permission_denied | The API key doesn’t have the required permission |
500 | server_error | An unexpected server error occurred |
Property | Type | Description |
---|---|---|
id | integer | The database ID of the contact |
first_name | string | First name of the contact |
last_name | string | Last name of the contact |
full_name | string | Combined first and last name |
email | string | Email address of the contact |
company | string | Company or organization name |
stage | string | Current stage in the sales/contact pipeline |
status | string | Current status of the contact |
phone | string | Primary phone number of the contact |
created_date | string | ISO 8601 date when the contact was created |
last_call_date | string | ISO 8601 date of the most recent call with this contact |
tags | array | Array of tag names associated with the contact |
team | object | Team information if the contact belongs to a team |
This endpoint returns contacts that the authenticated user has access to. This includes: