Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

Use a workspace API key in the Authorization header. Keys use pk_live_<key_id> for production and pk_test<key_id>_ for test mode.

Query Parameters

externalId
string

Filter by your external customer id.

Case-insensitive substring match over name, email, and company.

identityChannel
string

With identityIdentifier, resolve the customer owning a channel identity ("who is +62812… on WhatsApp?"). Both must be provided together; the result is a 0-or-1 item list.

identityIdentifier
string

The identity value to look up (e.g. a phone number).

limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string

Opaque keyset cursor from a prior response's nextCursor. Omit for the first page. Malformed or tampered cursors return 400.

Response

Customers.

data
object[]
required
hasMore
boolean
required

True when more rows exist beyond this page.

nextCursor
string | null

Opaque cursor for the next page. Pass it as the cursor query param. Null when hasMore is false.