List Customers
listCustomersList Customers
Retrieve project customers with optional search, tag, exact email or phone, sort, facet filters, and calendar bounds on a chosen datetime column. phone matches E.164 when the value is parseable. To create or match by contact without an id, use POST /customers (email first, then phone).
List endpoints are paginated. Use the page and limit query parameters to paginate through results (at most 30 records per page). Check the pagination object in the response (current_page, last_page, total) to determine if more pages exist and whether to continue fetching.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Search string matching customer first name, last name, full name, email, or company. Case-insensitive partial match. At most 100 characters. | |
| page | No | Which page of results to return (1 is the first page). Omit this field or use 1 for the first page. Accepts minimum 1. | |
| No | Email address for the person or customer. | ||
| limit | No | Maximum number of records to return. Accepts an integer from 1 to 30. | |
| phone | No | Exact phone filter. Normalized to E.164 when parseable (same helper as create/upsert), then matched on phone_e164. Unparseable values match the raw phone column. | |
| filter | No | Customer list facet aligned with console filters (excluding archived unless requested). | |
| date_to | No | Inclusive upper calendar date (YYYY-MM-DD) for the column chosen by date_key; must be on or after date_from when both bounds are provided. | |
| date_key | No | Customer datetime column paired with date_from and date_to (defaults to created_at when omitted). | |
| sort_dir | No | Sort direction: asc or desc. | |
| sort_key | No | Customer field to sort by. | |
| tag_slug | No | URL-friendly identifier for the customer tag. | |
| date_from | No | Inclusive lower calendar date (YYYY-MM-DD) for the column chosen by date_key, defaulting to created_at when date_key is omitted. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Short code or application-level status code for this resource. | |
| data | No | Response payload for the request. | |
| success | No | Indicates whether the request completed successfully. | |
| pagination | No | Pagination metadata for list responses. |