List customers
Lists or searches customers connected to your account. All supported query parameters are optional. If none are provided, the response will include all customers connected to your account. This endpoint supports advanced sorting and filtering options.
Query parameters
Page number for paginated results. Starts at 1.
Page number for paginated results. Starts at 1.
Number of results per page. Maximum: 1000.
Number of results per page. Maximum: 1000.
Start date for filtering by created_at date.
Start date for filtering by created_at date.
End date for filtering by created_at date.
End date for filtering by created_at date.
Filter customers by name (partial match).
Filter customers by name (partial match).
Filter by your system's external_id.
Filter by your system's external_id.
Filter customers by email address.
Filter customers by email address.
Filter customers by their current status.
Filter customers by their current status.
General search term to filter customers.
General search term to filter customers.
Filter by customer type individual or business.
Filter by customer type individual or business.
Headers
For use by platforms to specify an account_id to set the scope of a request.
Optional client generated identifier to trace and debug a request.
Optional client generated identifier to trace and debug a series of requests.
Response
OK