SnozeDevelopers
API referenceSurfaces

Preview what deleting a surface would affect

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

GET
/v1/workspaces/{workspaceId}/surfaces/{surfaceId}/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
surfaceId*string

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.snoze.dev/v1/workspaces/string/surfaces/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 surface

Recomputes the deletion impact, refuses the delete while blocking dependents remain, and otherwise removes the surface and its workspace item. Requires `surfaces:write` on the surface. When the impact contains warnings the call is rejected until it is repeated with `confirmed=true`.

List a surface's blocks in document order

Returns a window of the surface's block tree flattened into depth-first document order, together with the workspace version the window was read at. Requires `surfaces:read` on the surface. Paginated: pass `limit` (default 200, maximum 500) and the `cursor` from the previous response; a cursor that does not decode is rejected as a validation error.