v1
latestOpenAPI 3.0.32026-07-23215362.6 KBCustomers
Get Customers
Retrieve a list of customers with optional filtering and pagination.
get/v1/customers
Query parameters
customerStatus'ONBOARDING' | 'ACTIVE' | 'INACTIVE' | 'ONBOARDING_FAILED'
Filter customers by status
createDateStartstring date-time
Filter customers by creation date lower bound, exclusive
createDateEndstring date-time
Filter customers by creation date upper bound, inclusive
referenceIdstring
Filter customers by reference ID
afterstring
When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted.
limitstring integer
When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted.
sortField'customerStatus' | 'createdDate' | 'referenceId'
Will sort the returned data using the specified field.
sortDirection'ASC' | 'DESC'
Specifies the sort direction for the sortField.
Response
OK