Skip to main content
GET
Search Contacts

Authorizations

api_access_token
string
header
required

Token de usuario. Envía el valor en el header api_access_token. Lo obtienes en el perfil (GET /api/v1/profile) o al regenerarlo.

Path Parameters

account_id
integer
required

The numeric ID of the account

Query Parameters

q
string

Search using contact name, identifier, email or phone number

sort
enum<string>

The attribute by which list should be sorted

Available options:
name,
email,
phone_number,
last_activity_at,
-name,
-email,
-phone_number,
-last_activity_at
page
integer
default:1

The page parameter

Response

Success

meta
object
payload
object[]

List of contacts