Cascade-deletes an organisation and every row that FK-transitively depends on it (~276 tables). The target must have been deactivated first (deleted_date IS NOT NULL) unless skipDeactivationCheck: true is passed. Users whose canonical contact was in this org are repointed to another org membership if any, or deleted otherwise. Returns a per-table row-count report. Use dryRun: true first to preview the impact.
JSON body
organisationIdnumberRequiredTarget organisation id to hard-purge.
dryRunbooleanOptionalCompute the plan + row counts without deleting.
skipDeactivationCheckbooleanOptionalBypass the "must be deactivated first" gate. Only use for confirmed bot/spam organisations.
1 status code documented
successbooleanRequiredreportobjectRequiredorganisationIdnumberRequiredorganisationNamestringRequireddryRunbooleanRequiredstatsobjectRequireddirectCountnumberRequiredtransitiveCountnumberRequiredfkEdgesInScopenumberRequiredselfRefsPreNullednumberRequiredtablesTouchednumberRequiredrowsDeletedByTableobjectRequiredtotalRowsDeletednumberRequiredblobsDeletedFromStoragenumberRequiredusersRepointednumberRequiredusersDeletednumberRequirednullableRefsSetNullnumberRequired{
"success": false,
"report": {
"organisationId": 0,
"organisationName": "example_organisationName",
"dryRun": false,
"stats": {
"directCount": 0,
"transitiveCount": 0,
"fkEdgesInScope": 0,
"selfRefsPreNulled": 0
},
"tablesTouched": 0,
"rowsDeletedByTable": {},
"totalRowsDeleted": 0,
"blobsDeletedFromStorage": 0,
"usersRepointed": 0,
"usersDeleted": 0,
"nullableRefsSetNull": 0
}
}POST /bff/organisation/lifecycle/purge
curl -X POST "https://api.bizkithub.com/bff/organisation/lifecycle/purge" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"organisationId": 0,
"dryRun": false,
"skipDeactivationCheck": false
}'All BizKitHub public API endpoints require authentication via API key.