Skip to main content
POST
List contacts

Authorizations

X-API-Key
string
header
required

Preferred. API key value directly.

Query Parameters

channelId
string

Channel id. Auto-selects when omitted.

Example:

"ch_123"

page
number

Page number, default 1.

Example:

1

limit
number

Per page, default 50, max 200.

Example:

50

Matches name or phone (case-insensitive).

Body

application/json
channelId
string

Channel id. Auto-selects when omitted.

Example:

"ch_123"

page
number

Page number, default 1.

Example:

1

limit
number

Per page, default 50, max 200.

Example:

50

Matches name or phone (case-insensitive).

Response

Success. Envelope: { success:true, data, message? }.

success
boolean
required
Example:

true

data
any
message
string
pagination
object
total
number
Last modified on September 20, 2026