Skip to main content
GET
Search Contacts

Authorizations

api_access_token
string
header
required

Query Parameters

q
string

Search using contact name, identifier, email or phone number

sort
enum<string>

Field for sorting results

Available options:
name,
email,
created_at,
updated_at

Response

Contacts retrieved successfully

success
boolean
Example:

true

data
object[]

Array of contacts

meta
object
message
string

Success message

Example:

"Contacts retrieved successfully"