Skip to main content
GET
Search Contacts

Authorizations

Authorization
string
header
required

Authenticate with Authorization: Bearer <token> using a user API token from Profile Settings. Available in Chatwoot v4.19.0 and later.

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