Skip to content
UltimateTeam.ai Docs

GDPR Art. 20 — Data portability export

POST
/api/v1/export/portable
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/export/portable \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "format": "json" }'

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

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
PortableExportRequest

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

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

object
format
Format

Export format: ‘json’

string
default: json

Responses

Section titled “ Responses ”

202

Section titled “202”

Successful Response

Media typeapplication/json
PortableExportResponse

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
Export Id
string format: uuid
message
required
Message
string
status
required
Status
string
Examplegenerated
{
  "export_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "message": "example",
  "status": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}