Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer aw_live_…. Manage keys in the dashboard under Settings → API Keys.

Query Parameters

page
integer
Required range: x >= 1
page_size
integer
Required range: 1 <= x <= 100

Fuzzy match on email, name, phone, external_id.

kind
enum<string>
Available options:
lead,
user
has_email
enum<string>
Available options:
true,
false

Response

200 - application/json

A page of customers

object
string
Allowed value: "list"
data
object[]
total
integer
page
integer
page_size
integer