Skip to main content
GET
List Customers

Authorizations

X-API-Key
string
header
required

API Key for authentication

Query Parameters

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

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

created_before
string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

updated_after
string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

updated_before
string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

ids
string[]

Filter by customer IDs. Repeat param for multiple: ?ids=&ids=

reference_ids
string[]

Filter by reference IDs. Repeat param for multiple: ?reference_ids=ref_1&reference_ids=ref_2

sort_by
enum<string>
default:updated_at
Available options:
created_at,
updated_at,
company_name,
display_name
sort
enum<string>
default:desc
Available options:
asc,
desc
source
string[]

Include customers with these sources e.g. openapi(Open API), sales_rep(Wizorder). Repeat param for multiple: ?source=openapi&source=sales_rep

exclude_source
string[]

Exclude customers with these sources e.g. openapi(Open API), sales_rep(Wizorder). Repeat param for multiple: ?exclude_source=sales_rep&exclude_source=openapi

Response

OK

data
object[]
pagination
object