Pular para o conteúdo principal

Organização e schemas

O perfil da própria organização, dashboards_workspaces_list — os workspaces que você pode usar no argumento workspace_id —, dashboards_schemas_get, o catálogo de campos que diz o que pedir em fields e em sort_by, e as suas aprovações por link: dashboards_operation_approvals_get diz o que aconteceu com uma operação depois que você decidiu no link.

Famílias nesta página​

FamíliaToolsreadwritedestructive
settings — Organização e schemas6420
workspaces — Workspaces9531
operation-approvals — Aprovações por link2200

settings​

ToolTipoEscopoPermissãoEndpointO que faz
dashboards_organization_getreadreadsettings.viewGET /v1/organizationFetch the organization the access token acts for — name, contact details and settings.
dashboards_organization_updatewritewritesettings.updatePATCH /v1/organizationUpdate the organization profile: its addresses and custom metadata.
dashboards_settings_getreadreadsettings.viewGET /v1/settingsRead the organization settings: name, support e-mail, timezone and the records toggles (upper-case names, who may create/edit portal users…).
dashboards_settings_updatewrite · confirmação (conforme os argumentos)writesettings.updatePUT /v1/settingsChange organization settings.
dashboards_mereadqualquer tokensettings.view— (local)Return the identity behind this connection's access token: the person (user), the organization and the token itself (type, scopes, access levels, expiry).
dashboards_schemas_getreadreadsettings.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​

ToolTipoEscopoPermissãoEndpointO que faz
dashboards_workspaces_searchreadreadworkspaces.listGET /v1/workspacesList the workspaces of the organization you can open, with your role (owner/member) in each — filter by a name substring with search.
dashboards_workspaces_getreadreadworkspaces.showGET /v1/workspaces/:idFetch one workspace you can open, with your role in it and its entity field limit.
dashboards_workspaces_createwritewriteworkspaces.createPOST /v1/workspacesCreate a new, empty workspace in the organization; you become its owner.
dashboards_workspaces_updatewritewriteworkspaces.updatePATCH /v1/workspaces/:idRename a workspace (workspace owners only).
dashboards_workspaces_deletedestructivedeleteworkspaces.deleteDELETE /v1/workspaces/:idDelete a workspace (workspace owners only): its portal goes offline, its connectors stop syncing and its members lose access.
dashboards_workspaces_usagereadreadworkspaces.showGET /v1/workspaces/:id/usageCount what deleting a workspace would hide — its portal users, connectors and webhooks — and whether it is empty.
dashboards_workspaces_exportreadexportworkspaces.showGET /v1/workspaces/:id/exportExport 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_importwrite · confirmaçãoimportworkspaces.createPOST /v1/workspaces/importCreate a NEW workspace, owned by you, from a file produced by dashboards_workspaces_export.
dashboards_workspaces_listreadreadworkspaces.list— (local)List the workspaces you can act on.

operation-approvals​

ToolTipoEscopoPermissãoEndpointO que faz
dashboards_operation_approvals_getreadqualquer dashboards/… ou allsettings.view— (local)Get one of your operation approvals by id — the approval.id a destructive tool answered with status: "approval_required".
dashboards_operation_approvals_listreadqualquer dashboards/… ou allsettings.view— (local)List your operation approvals, newest first, in this workspace and at organization level.

Os campos de cada recurso estão na Referência da API e em dashboards_schemas_get.

Uma tool que você não pode rodar não aparece em tools/list. Se uma daqui não está lá, veja Autenticação.