SnozeDevelopers
API referenceActions

List the actions available in a given context

Returns the enabled actions that apply to one context - pass the workspace item `kind` and, when they exist, its `itemId` and `targetId` - combining derived system actions with the workspace's own enabled actions. Requires the `actions:read` permission in the workspace.

GET
/v1/workspaces/{workspaceId}/available-actions

Authorization

apiKey
AuthorizationBearer <token>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

In: header

Path Parameters

workspaceId*string

Query Parameters

kind*string

Value in

  • "folder"
  • "page"
  • "note"
  • "dashboard"
  • "canvas"
  • "view"
  • "form"
  • "database"
  • "file"
  • "data_source"
  • "action"
  • "automation"
  • "external_resource"
  • "calendar"
itemId?string|null
targetId?string|null

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/workspaces/string/available-actions?kind=folder"
{  "data": [    {      "id": "string",      "label": "string",      "icon": "string",      "group": "string",      "requiresConfirmation": true,      "target": {        "kind": "folder",        "id": "string"      },      "connectorOperation": {        "kind": "connector_operation",        "connector": "string",        "operation": "string",        "inputFields": [          {            "name": "string",            "label": "string",            "required": true,            "type": "text",            "options": [              {                "value": "string",                "label": "string"              }            ],            "secret": true,            "placeholder": "string"          }        ],        "connectionId": "string",        "connectionLabel": "string"      },      "itemAction": {        "key": "save_as_template",        "itemId": "string"      }    }  ]}

Create an action

Creates an action from a typed config and registers a matching workspace item for it. Requires the `actions:write` permission; the config is validated, so a config whose kind disagrees with `kind`, an unusable connector reference, or (for an enabled action) a step pointing at a target that does not exist is rejected with a validation error. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.

Get a single action

Returns one action with its decoded config. Requires the `actions:read` permission plus view access to that action; an unknown id returns not-found.