list_customers
Fetch paginated customers from your Plane workspace. Filter by name, set page size, and follow the cursor to retrieve every matching customer.
Instructions
List customers in the workspace (paginated).
Args: query: Filter to customers whose name contains this text. cursor: Prior response's next_cursor; omit for first page. per_page: Results per page (1-1000, default 1000).
Returns: Paginated envelope: results + total_count, next_cursor, next_page_results (page again while next_page_results is true).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | ||
| cursor | No | ||
| per_page | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | ||
| results | Yes | ||
| grouped_by | No | ||
| extra_stats | No | ||
| next_cursor | Yes | ||
| prev_cursor | Yes | ||
| total_count | Yes | ||
| total_pages | Yes | ||
| total_results | Yes | ||
| sub_grouped_by | No | ||
| next_page_results | Yes | ||
| prev_page_results | Yes |