List customers
list_customersRetrieve customer accounts that sign in to your site with status, verification, last login, company role, price list and order stats; filter by status, company or email search.
Instructions
List the customers - accounts that sign in to the user's site (records of an accounts model), with status, verification, last login, their company, companyRole (the effective company role: admin or buyer in v1, null without a company), effectivePriceList (the price list that prices them, source MEMBER or COMPANY; null = catalogue prices) and orderStats (non-canceled order count, last order date, and net spend = paid minus refunded, in minor units, one entry per currency; null when the caller may not view orders). Not the team: those are list_team. Read-only; filter by model, status, company or an identity search; newest first. Paginated: while hasMore is true, pass nextCursor back as cursor while it is set; if hasMore is true but nextCursor is null, page with the offset instead, and past offset 10000 narrow the filter.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_customers"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skip | No | How many rows to skip, at most 10000; page past that with cursor | |
| limit | No | ||
| cursor | No | nextCursor from the previous page. The page continues after it in the same filter and sort; leave the skip/offset at 0 when you pass it | |
| search | No | Case-insensitive match against the sign-in identity (email) | |
| status | No | Filter by account status | |
| modelId | No | Only customers of this accounts model, by id or slug (from list_models) | |
| companyId | No | Only customers linked to this company record |