SnozeDevelopers
API referenceDatabases

Preview what deleting a field would affect

Returns the views, formulas, rollups, buttons and other references that depend on the field, with an overall status saying whether deletion is safe, needs confirmation, or is blocked. Read-only. Requires the `databases:write` permission.

GET
/v1/workspaces/{workspaceId}/databases/{databaseId}/fields/{fieldId}/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
databaseId*string
fieldId*string

Response Body

Success

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

Preview a field type conversion

Runs the same conversion matrix the field update uses and returns the resulting plan: whether the pair of kinds is supported, how many values stay clean, are coerced, are narrowed or are dropped, the options it would mint, sample rows, and side effects such as view rules or formulas that would break. Nothing is written. Requires the `databases:write` permission.

List the records in a database

Returns records with their hydrated cell values, linked-record titles and computed fields. Pass `search` for a ranked full-text match over record content and `limit` to cap the response, which is clamped to between 1 and 100; without `limit` every record is returned in creation order. Requires the `records:read` permission on the database.