Skip to content

GDPR Art. 20 — Data portability export

POST
/api/v1/export/portable

Queues an asynchronous export of all tenant data as a downloadable archive. Returns 202 Accepted with an export_id. Poll GET /export/{export_id} for status.

Authorizations

Request Body required

Request body for POST /export/portable (GDPR Art. 20).

Attributes: format: Desired export format. Currently only “json” is supported.

object
format

Export format: ‘json’

string
default: json

Responses

202

Successful Response

Response body for POST /export/portable (GDPR Art. 20).

Attributes: export_id: Unique identifier for the async export job. status: Current processing status. message: Human-readable description.

object
export_id
required
string format: uuid
message
required
string
status
required
string

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string