Sign in

v1

latestOpenAPI 3.0.02026-07-1313126.3 KB
contact

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.

get/contact

Query parameters

searchstring

Search term to filter contacts by name, phone number, or other attributes.

phone_numbers_onlyboolean

Filter results to show only contacts with phone numbers.

tagsstring[]

Filter results by tags associated with the contacts. You can specify multiple tags.

excluded_tagsstring[]

Exclude contacts that have these tags.

sortstring

Sort the contacts based on a specific field, such as name or creation date.

sortDirection'asc' | 'desc'

Specify the sort direction. Choose either ascending ('asc') or descending ('desc').

pageinteger

Specify the page of results to retrieve (pagination).

limitinteger

Specify the maximum number of contacts to return per page (pagination). The default is 20.

Response

Successful response

errorobject nullable

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.

dataobject required

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.