crm_customers_list
Locate customer records by searching IDs, name, address, phone, coordinates, external data, or date ranges. Returns one page of matching results.
Instructions
Search customers by IDs, name, address, phone, coordinates, external data, activity, or created and modified ranges. Returns one page; use crm_customers_get for a known ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Comma-delimited customer IDs | |
| zip | No | Filter by zip | |
| city | No | Filter by city | |
| name | No | Filter by name | |
| page | No | Page number (starts at 1) | |
| sort | No | Sort: Field (default), +Field (asc), or -Field (desc). Fields: Id, ModifiedOn, CreatedOn | |
| unit | No | Filter by unit | |
| phone | No | Filter by contact phone | |
| state | No | Filter by state | |
| active | No | Filter by active status | True |
| street | No | Filter by street | |
| country | No | Filter by country | |
| latitude | No | Filter by latitude | |
| pageSize | No | Records per page (default 50) | |
| longitude | No | Filter by longitude | |
| includeTotal | No | Include total count in response | |
| createdBefore | No | ||
| modifiedBefore | No | ||
| externalDataKey | No | External data key | |
| createdOnOrAfter | No | ||
| modifiedOnOrAfter | No | ||
| externalDataValues | No | External data values | |
| externalDataApplicationGuid | No | External data application GUID | |
| excludeAccountingChangesFromModifiedDateRange | No | Exclude accounting-only changes from modified date filters |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||