- List customers
Tool name: list_customers
Returns the customers that match what is asked for, with status, segment, region, products, ARR in the organization’s currency, next renewal date, the date of the last meeting, and their IDs in the organization’s CRM and other sources. Use it for questions such as "which customers renew in the next 30 days", "my largest enterprise customers", "which customers have we not met since March" or "which customers does this member look after". ARR is what a customer pays now, so a churned customer usually has an ARR of 0; null means the ARR is not known. Every filter given must match. Highest ARR first, unless sortBy says otherwise. To find a customer by name, use find_customers.
mine: customers the member is assigned to. team: customers the member or their team is assigned to. all: every customer the member can see
Only customers in one of these states
Only customers in one of these segments, as named by get_customer
Only customers last met on or before this day. Customers never met are not included
Only customers this member is assigned to, by the member’s ID
With memberId, only customers where the member holds this role, by the role’s ID from get_organization_context
Filters on the organization’s custom fields, by the key of each field from get_organization_context. Give a list of values to match any of them, such as {"tier": ["gold", "silver"]}; a true or false field takes "true" or "false". For a number or date field, give a range with both ends, such as {"seats": {"from": "100", "to": "500"}}
How many to return, up to 100. Ask for more only if the first results were not enough
{ "scope": "mine", "statuses": [ "active" ], "segments": [ "string" ], "regions": [ "string" ], "countries": [ "string" ], "renewalFromDate": "2019-08-24", "renewalToDate": "2019-08-24", "lastMeetingFromDate": "2019-08-24", "lastMeetingToDate": "2019-08-24", "minArr": 0, "maxArr": 0, "memberId": -9007199254740991, "memberRoleId": -9007199254740991, "customFields": { "property1": [ "string" ], "property2": [ "string" ] }, "sortBy": "arr", "sortOrder": "ascending", "limit": 10, "offset": 0 }