Skip to main content
POST
Request a DSAR / tenant-export job

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <api-key>.

Body

application/json
scope
object
required
format
enum<string>
default:JSON

Export format. Unrecognised values fall back to JSON.

Available options:
JSON,
CSV,
NDJSON,
PARQUET
requestedBy
string

Requester attribution. Defaults to the key's developerId.

requestNotes
string | null

Optional rationale captured for the audit trail.

Response

The created job (state REQUESTED) and the active-job cap.

ok
boolean
required
data
object
required

Route-specific payload. Operation responses refine this.

contractVersion
string
required
Allowed value: "v1.0"