list_customers
Retrieve customers—organisations projects are attached to and billed for—filtered by name, active status, or managers. Use it to find a customer's id or name before creating or listing projects.
Instructions
List customers, the organisations projects are attached to and billed for. Use it to find a customer's id or name before create_project or list_projects(customer=...); use get_customer for one customer's detail. Read-only. Filter by name fragment, active status, or managers given by name, email or id. An empty result is an empty list, not an error.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many objects to return. Upstream maximum is 1000. | |
| query | No | Keep only customers whose name contains this text. | |
| offset | No | How many objects to skip, for the next page. | |
| managers | No | Keep only customers managed by these people, by name, email or id. | |
| is_active | No | Keep only active, or only inactive, customers. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | Set when the answer is worth a word of explanation. | |
| count | Yes | How many objects match the filters upstream, beyond this page. | |
| items | Yes | The objects. | |
| returned | Yes | How many objects this answer carries. |