tenancy

POST /v1/orgs/{orgId}/privacy/exports

Ask for a machine-readable copy of all of this organization's data.

All tenancy endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.

Where your organisation id goes

This endpoint takes your organisation id in the URL itself, as orgId. Substitute it into the path — there is no header or query parameter that will do instead.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/orgs/{orgId}/privacy/exports \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Starts a durable workflow that writes a zip of JSON Lines — one file per kind of record, every org-scoped table, plus the org's members — read under the org's own RLS scope. Credentials and key material are written as [redacted]. The archive can be downloaded for 7 days and is then deleted. Needs a sign-in from the last five minutes (403 STEP_UP_REQUIRED otherwise). An export already building or ready from the last 24 hours is returned with 200 instead of starting another; a new one answers 202. If the workflow cannot be started the request is refused with 503, never left pending.

Parameters

NameTypeRequiredWhat it is
orgId (path)UuidYesOrganization ID (UUIDv7).

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
kindstring<export, erasure>Yes—
statusPrivacyRequestStatusYes—
created_atstringYes—
erase_afterobjectYesErasure only — when the cooling-off period ends and the erasure runs.
completed_atobjectYes—
cancelled_atobjectYes—
expires_atobjectYesExport only — when the archive is deleted.
size_bytesintegerYes—
row_countintegerYes—
table_countintegerYes—
retain_untilobjectYesErasure only — the last day the retained tax records are kept.

Errors this endpoint can return

401 · 403 · 404 · 429 · 503