SnozeDevelopers
API referenceResources

Preview what deleting a workspace item would affect

Returns the dependency impact report for the item, separating dependents that block deletion from ones that are only warnings. Requires read access to the item. Use it before `delete` to decide whether the confirmation flag is needed.

GET
/v1/workspaces/{workspaceId}/items/{itemId}/deletion-impact

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

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

Path Parameters

workspaceId*string
itemId*string

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.snoze.dev/v1/workspaces/string/items/string/deletion-impact'
Example Response
{  "data": {    "target": {      "kind": "workspace_item",      "id": "string",      "label": "string"    },    "status": "safe",    "summary": {      "blockers": 0,      "warnings": 0,      "cascades": 0    },    "entries": [      {        "id": "string",        "kind": "workspace_item",        "level": "blocking",        "label": "string",        "reason": "string",        "action": "string",        "remediation": {          "capability": "actions.delete",          "args": {            "actionId": "string"          }        },        "owner": {          "id": "string",          "kind": "string",          "label": "string"        }      }    ]  }}

Delete a workspace item

Recomputes the deletion impact and deletes the item and its folder contents. Trash clients send `permanent=true`: this requires the root and affected items to remain in Trash and commits the whole cascade atomically, preventing restore or move from interleaving. Ordinary canonical deletion remains supported without this flag. Returns the item as it was before removal. Requires write access to every affected item. When the impact carries warnings the call is rejected until it is repeated with `confirmed=true`.

Get a surface's publish settings

Returns the surface's public-site configuration -- slug, SEO indexing, cover image, icon visibility, and theme -- or a disabled config when it has never been published. Requires view access to the surface and a signed-in session; API keys are not accepted. An unknown surface is reported as a not-publishable error.