List customers
cratejoy_list_customersList customers (id, name, email, country, location, num_orders, num_subscriptions, subscription_status, total_revenue). Filter by email or name, or with filters (e.g. { 'addresses.city': 'Austin' }). Relationships: addresses, logs, carts, notes, orders, shipments, subscriptions. GET /v1/customers/.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Customer name contains this text (case-insensitive). | |
| page | No | Page number, counting from 0 (default 0). Pass the previous reply's next_page. | |
| with | No | Relationships to embed: comma-separated names (e.g. 'customer,orders'), 'all', or an empty string for none. Omit it for the vendor default. | |
| No | Exact customer email. | ||
| limit | No | Results per page, 1-100 (default 25). | |
| filters | No | Extra Cratejoy filters as { '[relation.]property[__comparison]': value }. Comparisons: eq (default), ne, lt, le, gt, ge, like, ilike (% is the wildcard), in, nin (comma-separated), is_null. Status columns take integers. Example: { 'customer.email__like': '%@example.com' }. |