Skip to main content

​
Exports API

Exports run as async jobs and are workspace-scoped.

​
Endpoint matrix

MethodPathPurpose
POST/exportsCreate export job
GET/exportsList latest workspace exports
GET/exports/:idGet one export status/details
GET/exports/:id/downloadDownload completed export file

​
Create payload

  • type: links | partners | commissions | events
  • format: csv | json
  • programId (optional)
  • filters (optional)
  • columns (optional)
Creation returns 202 Accepted with export ID and initial pending state.

​
Job lifecycle

Typical statuses:
  • pending
  • processing
  • completed
  • failed

​
Download behavior

  • available only when status is completed
  • file can expire based on retention policy
  • download response streams file from object storage

​
Permission model

  • Requires workspace auth.
  • Requires links:read.

​
Typical failures

  • 404: export not found in workspace scope
  • 400: export not ready yet
  • 410: export file expired
  • 503: export workflow service unavailable
Related docs:
  • /user-guides/manual/data/exports-and-operational-checks
  • /user-guides/manual/data/data-retention-and-lifecycle