List workspaces
list_workspacesRetrieve the current user's workspaces, including group, pinned status, and optional contact details, with filters by name, group ID, or label and paging for large sets.
Instructions
The current user's workspaces (a practice usually keeps one per client), with their group and whether they are pinned. Pages through the API 50 at a time until it returns a short page, which the API documents as the end of the list. q, group_id and label are passed through as the API's q, g and l parameters; the spec does not describe them further.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| first | No | Index of the first workspace (0-based), for continuing a previous call | |
| label | No | Passed as the API's l parameter (undocumented; presumably a workspace label from list_workspace_labels) | |
| query | No | Passed as the API's q parameter (undocumented; presumably a name search) | |
| group_id | No | Passed as the API's g parameter (undocumented; presumably a workspace group ID) | |
| max_results | No | ||
| include_contact_details | No | Include email addresses, event locations and the links into a client's view of a request, and stop redacting emails, phone numbers, postcodes and NI numbers from names, labels and other free text |