Organization and schemas
The organization profile itself, dashboards_workspaces_list — the workspaces you can pass as workspace_id — and dashboards_schemas_get, the field catalogue that tells you what to ask for in fields and in sort_by.
Families on this page
| Family | Tools | read | write | destructive |
|---|---|---|---|---|
settings — Organization and schemas | 6 | 4 | 2 | 0 |
workspaces — Workspaces | 9 | 5 | 3 | 1 |
settings
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
dashboards_organization_get | read | settings.view | GET /v1/organization | Fetch the organization the access token acts for — name, contact details and settings. |
dashboards_organization_update | write | settings.update | PATCH /v1/organization | Update the organization profile. |
dashboards_settings_get | read | settings.view | GET /v1/settings | Read the organization settings: name, support e-mail, timezone and the records toggles (upper-case names, who may create/edit portal users…). |
dashboards_settings_update | write | settings.update | PUT /v1/settings | Change organization settings. |
dashboards_me | read | settings.view | — (local) | Return the identity behind this connection's access token: the person (user), the organization and the token itself (type, scopes, access level, expiry). |
dashboards_schemas_get | read | settings.view | — (local) | Describe the fields of a resource: every field name, its type, whether it is nullable, its enum values and what it means. |
workspaces
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
dashboards_workspaces_search | read | workspaces.list | GET /v1/workspaces | List the workspaces of the organization you can open, with your role (owner/member) in each — filter by a name substring with search. |
dashboards_workspaces_get | read | workspaces.show | GET /v1/workspaces/:id | Fetch one workspace you can open, with your role in it and its entity field limit. |
dashboards_workspaces_create | write | workspaces.create | POST /v1/workspaces | Create a new, empty workspace in the organization; you become its owner. |
dashboards_workspaces_update | write | workspaces.update | PATCH /v1/workspaces/:id | Rename a workspace (workspace owners only). |
dashboards_workspaces_delete | destructive | workspaces.delete | DELETE /v1/workspaces/:id | Delete a workspace (workspace owners only): its portal goes offline, its connectors stop syncing and its members lose access. |
dashboards_workspaces_usage | read | workspaces.show | GET /v1/workspaces/:id/usage | Count what deleting a workspace would hide — its portal users, connectors and webhooks — and whether it is empty. |
dashboards_workspaces_export | read | workspaces.show | GET /v1/workspaces/:id/export | Export a workspace configuration (portal builder, portal access and settings, user mapping, connectors and entities) as JSON, without secrets or data — workspace owners only. |
dashboards_workspaces_import | write | workspaces.create | POST /v1/workspaces/import | Create a NEW workspace, owned by you, from a file produced by dashboards_workspaces_export. |
dashboards_workspaces_list | read | workspaces.list | — (local) | List the workspaces you can act on. |
The fields of each resource are in the API reference and in dashboards_schemas_get.
A tool you cannot run is not listed by tools/list at all. If one from this page is missing, see Authentication.