Customers
Get all customers
get/v1/customers
Query parameters
limitnumber
Number of results to return (1-1000). Use with offset for traditional pagination.
offsetnumber
Number of results to skip. Use with limit for traditional pagination.
page_sizenumber
Number of results per page (1-1000). Use with starting_after for cursor-based pagination.
starting_afterstring
Cursor for pagination. Use the ID of the last item from the previous page to get the next page. Use with page_size for cursor-based pagination.
status'DRAFT' | 'IN_REVIEW' | 'NEED_ACTIONS' | 'REJECTED' | 'ACTIVE' | 'INACTIVE' | 'SUSPENDED'
Filter by customer status
type'INDIVIDUAL' | 'BUSINESS'
Filter by customer type
searchstring
Search by customer name or email
organizationIdstring
Filter by organization ID. Must be within the caller accessible org scope.
Headers
X-API-Keystring
API key
Response
Paginated list of customers
Changes
No recorded changes to this endpoint across all 1 revision of this API.