Endpoint
Query Parameters
Response Format
Array of customer objects. See Customer Object for structure.
Examples
Basic List Request
Response
Filtered List Request
Pagination
The API uses cursor-based pagination to handle large collections of customers. To fetch the next page of results:-
Get the
aftercursor from the pagination object -
Pass it as the
afterparameter in your next request -
Repeat until no more
aftercursor is returned
For optimal performance, we recommend:
- Use reasonable page sizes (15-50 records)
- Cache results when possible
- Implement progressive loading in your UI
Error Responses
Rate Limits
List operations are subject to the following rate limits:- 100 requests per minute per API key
- 1000 requests per hour per API key
Best Practices
- Efficient Filtering: Use filters to reduce response size and improve performance
- Cursor Management: Store cursors temporarily for pagination
- Bulk Operations: Use higher limit values for bulk data retrieval
- Error Handling: Implement proper retry logic for rate limits
- Data Freshness: Consider implementing cache invalidation strategies