Read a personal data export request.

GET

/api/user/data-export/{id}

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/user/data-export/example \
  --header 'Authorization: Bearer <token>'

Returns status and metadata for an export request owned by the authenticated user.

Authorizations

• userBearer
• userSessionCookie

Parameters

Path Parameters

id

required

string

Responses

200

Successful JSON response.

Media type application/json

object

id

required

string

publicArtifactId

string

userId

required

string

status

required

string

Allowed values: pending processing completed failed expired

format

required

string

Allowed values: json csv

includeSections

required

Array<string>

requestedAt

required

integer

startedAt

integer

completedAt

integer

expiresAt

integer

fileSize

integer

availableFormats

Array<string>

Allowed values: json csv

errorMessage

string

Example

{
  "id": "export_123",
  "publicArtifactId": "artifact_123",
  "userId": "user_123",
  "status": "completed",
  "format": "json",
  "includeSections": [
    "profile",
    "consents"
  ],
  "requestedAt": 1770000000000,
  "completedAt": 1770000005000,
  "fileSize": 4096,
  "availableFormats": [
    "json"
  ]
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}