Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

An API key created in Settings, sent as Authorization: Bearer <key>.

Query Parameters

nameLike
string

Only customers whose name contains this text, ignoring case.

billingCadence
enum<string>

Only customers with a contract that is not deleted whose current terms bill a subscription this often. A draft or ended contract counts.

Available options:
MONTHLY,
QUARTERLY,
SEMI_ANNUAL,
ANNUAL
contractHealthStates
string

Only customers whose contractHealth is one of these, separated by commas — for example RENEWAL_DUE,ENDING. The states are RENEWAL_DUE, ENDING, HEALTHY, UPCOMING, NO_ACTIVE_CONTRACT, DRAFT_ONLY, NO_CONTRACTS; contractHealth on the customer says what each means.

orderBy
string

Fields to order by, each written field:ASC or field:DESC and separated by commas, applied in the order written — for example contractHealth:ASC,name:ASC. Order by up to 3 of name, contractHealth, coverageContractStartAt, contractValueAmount, remainingToInvoiceAmount, createdAt. Omit it for the customers whose contracts most need attention first. contractValueAmount and remainingToInvoiceAmount compare the number alone, so 100 USD and 100 EUR sort together; a customer with no amounts counts as 0, and one with amounts in more than one currency, like one with no coverageContractStartAt, sorts last when ascending and first when descending.

startingAfter
string

The nextCursor of the previous page, to read the page after it.

Required string length: 1 - 1024
Pattern: ^[A-Za-z0-9._-]+$
endingBefore
string

The prevCursor of the previous page, to read the page before it.

Required string length: 1 - 1024
Pattern: ^[A-Za-z0-9._-]+$
limit
integer
default:50

Rows per page, 1 to 100.

Required range: 1 <= x <= 100

Response

Successful response

data
object[]
required
hasMore
boolean
required
nextCursor
string
prevCursor
string