Customer Lifetime Value List
list_customersList customers ranked by lifetime value (net profit after allocated overhead, summed across each customer's full order history) - the same source as the dashboard Customers page. start_date/end_date filter WHICH customers appear, by their first-order date; they do NOT clamp a customer's lifetime totals to that window. Customer name and email in the response are partially redacted. Each returned id identifies a customer record whose detail includes up to 200 recent orders.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dir | No | Sort direction, default 'desc'. | |
| page | No | Page number, 1-based (default 1). | |
| sort | No | Sort key: 'marginLtv' (net profit, default), 'revenueLtv', 'orderCount', or 'firstOrderAt'. | |
| limit | No | Rows per page, 1 to 50 (default 25). | |
| end_date | No | Only include customers whose first order falls on or before this date (YYYY-MM-DD, tenant timezone). Omit for all-time. | |
| start_date | No | Only include customers whose first order falls on or after this date (YYYY-MM-DD, tenant timezone). Omit for all-time. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| _meta | No | ||
| filters | No | ||
| summary | No | ||
| _message | No | ||
| currency | No | ||
| customers | No | ||
| _truncated | No | ||
| pagination | No | ||
| _tenant_context | No | ||
| attribution_enabled | No | When false, acquisition_channel and acquisition_country_code are unreliable and must not be reported as fact. |