Preview permanent subtree deletion
Requires record write access. Returns the root and every descendant, including archived records, with a fingerprint for confirmation. Read-only; no records are deleted. Branches above 1000 records must first be reduced through smaller reviewed deletions.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/string/databases/string/records/string/subtree-impact"{ "data": { "recordIds": [], "records": [], "fingerprint": "string" }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Move a sub-record with a parent precondition
Requires record write access. parentId null promotes to the top level. expectedParentId must match the stored parent; stale moves fail. A move carries descendants and rejects cross-database targets, archived parents, cycles and depth beyond 32 levels. The returned record omits its bulk children relation.
Permanently delete a reviewed subtree
Requires record write access and the fingerprint from subtree-impact. Revalidates the reviewed records and structure under the hierarchy lock, then permanently deletes the entire subtree atomically through canonical record deletion. A changed fingerprint fails without deleting records. Set requireTrashed=true for Trash-only deletion; every current target must remain archived before any deletion. Omit it for explicitly reviewed active subtree deletion. Send an Idempotency-Key to replay a successful request.