Skip to main content
POST
Request an organization data export

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization to export.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Query Parameters

archive_format
enum<string>
default:zip

Archive container format (defaults to zip).

Available options:
zip,
tar.gz

Response

OK

Status of an export job, with a signed download URL once complete.

job_id
string<shortuuid>
required

Public identifier of the export job; use it to poll this endpoint.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
status
enum<string>
required

Current job lifecycle state.

Available options:
pending,
processing,
completed,
failed
archive_format
enum<string>
required

Container format of the generated archive.

Available options:
zip,
tar.gz
format_version
string
required

Export format version baked into the archive manifest.

file_size_bytes
integer
required

Size of the generated archive in bytes (0 until complete).

output_filename
string | null

Suggested filename for the downloaded archive.

download_url
string | null

Time-limited signed URL to download the archive. Null until the job is complete.

expires_at
string | null

ISO-8601 instant after which the download URL stops working.

sections
OrgExportSectionOut · object[]

Per-section inventory of what was exported (also present inside the archive manifest).

error
string | null

Job-level error message if the export failed.