List customers

Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.

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.

Page number for paginated results. Starts at 1.

Number of results per page. Maximum: 1000.

Start date for filtering by created_at date.

End date for filtering by created_at date.

Filter customers by name (partial match).

Filter by your system's external_id.

Filter customers by email address.

Filter customers by their current status.

General search term to filter customers.

Filter by customer type individual or business.

Indicates the structure of the returned content.

• "object" means the data field contains a single JSON object.
• "array" means the data field contains an array of objects.
• "error" means the data field contains an error object with details of the issue.
• "none" means no data is returned.