Skip to main content
GET
List customers

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

sequence-version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Query Parameters

sortBy
string

Sort column. Default: creation time. Use customProperties. to sort by a custom property value.

Filter by legal name

email
string

Filter by email

alias
string

Filter by alias

label
string

Filter by label

includeArchived
boolean

Include archived customers

billingStatus
enum<string>

Filter by billing status, derived from active billing schedules. ACTIVE returns customers with a current billing schedule; INACTIVE returns customers without one. Invoices sent manually or via the API without a schedule do not count.

Available options:
ACTIVE,
INACTIVE
limit
integer<int32>

Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).

after
string

Pagination cursor.

before
string

Pagination cursor.

sortOrder
enum<string>

Sort order. Default: DESC.

Available options:
ASC,
DESC

Response

OK

items
object[]
required

Customers

Example:
pagination
object
required

Results pagination

Example: