Get contacts
This endpoint retrieves a list of Contacts. You can filter contacts by various criteria, such as tags, phone numbers, and more. Use the query parameters to narrow down your results.
Authorizations
API key for the user making the request. This can be found via the Developer Settings page in the dashboard.
Team identifier, used to scope requests to a specific team. This can be found via the Developer Settings page in the dashboard.
Query Parameters
Search term to filter contacts by name, phone number, or other attributes.
Filter results to show only contacts with phone numbers.
Filter results by tags associated with the contacts. You can specify multiple tags.
Exclude contacts that have these tags.
Sort the contacts based on a specific field, such as name or creation date.
Specify the sort direction. Choose either ascending ('asc') or descending ('desc').
asc, desc Specify the page of results to retrieve (pagination).
x >= 0Specify the maximum number of contacts to return per page (pagination). The default is 20.
1 <= x <= 50Response
The generic response format for all API requests. This structure ensures consistency in how success and error information is returned to the caller.
Contains the response data for the successful request. This field will vary based on the specific API endpoint being called and contains the main data returned from the API. For example, it may include information about a created contact, agent, or webhook subscription.
An object containing error details, if any. This field will be populated if the API request fails or encounters an error. If the request is successful, this field will be null or omitted.
Was this page helpful?