Skip to main content
GET
List Customers
Results come in pages of 50 by default. Merged customers aren’t included.

Authorizations

Authorization
string
header
required

Your API key. Create one under Setup → Developer API Keys and select the permissions this endpoint needs.

Scopes

contacts:read

Query Parameters

Search by name, phone or email.

type
enum<string>

Only customers of this type.

Available options:
lead,
customer,
guest
contact_status_id
integer

Only customers with this customer status.

contact_source_id
integer

Only customers from this customer source.

group_id
integer

Only customers in this customer group.

is_active
boolean

true for active customers only, false for inactive only.

page
integer
default:1

Page number.

per_page
integer
default:50

Customers per page, from 5 to 100.

Required range: 5 <= x <= 100

Response

200 OK

data
object[]
meta
object