Admin Export Service

List export jobs for the admin

{
  "data": [
    {
      "job_id": "job_eX3rPo",
      "org_id": "org_kNr8aQ",
      "format": "csv",
      "status": "completed",
      "row_count": 184,
      "created_at": "2026-03-25T09:00:00Z",
      "completed_at": "2026-03-25T09:01:12Z",
      "download_url": "/api/v1/admin/exports/job_eX3rPo/download"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 3
  }
}

Get status and metadata of an export job

{
  "data": {
    "job_id": "job_eX3rPo",
    "org_id": "org_kNr8aQ",
    "format": "csv",
    "status": "completed",
    "row_count": 184,
    "created_at": "2026-03-25T09:00:00Z",
    "completed_at": "2026-03-25T09:01:12Z",
    "download_url": "/api/v1/admin/exports/job_eX3rPo/download"
  }
}

Trigger a new export job

{
  "org_id": "org_kNr8aQ",
  "format": "xlsx",
  "entity_types": [
    "users",
    "activities"
  ],
  "date_from": "2026-01-01",
  "date_to": "2026-03-26",
  "include_sub_orgs": true
}

{
  "data": {
    "job_id": "job_fY9kWz",
    "org_id": "org_kNr8aQ",
    "format": "xlsx",
    "status": "queued",
    "created_at": "2026-03-26T11:45:00Z"
  }
}

Update export job config before it starts

{
  "format": "csv",
  "include_sub_orgs": false
}

{
  "data": {
    "job_id": "job_fY9kWz",
    "format": "csv",
    "include_sub_orgs": false,
    "status": "queued",
    "updated_at": "2026-03-26T11:46:00Z"
  }
}

Cancel a queued or in-progress export job

{
  "data": {
    "job_id": "job_fY9kWz",
    "status": "cancelled",
    "cancelled_at": "2026-03-26T11:47:00Z"
  }
}

List supported export formats

{
  "data": [
    {
      "format_id": "csv",
      "label": "CSV",
      "mime_type": "text/csv",
      "max_rows": 100000
    },
    {
      "format_id": "xlsx",
      "label": "Excel (XLSX)",
      "mime_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
      "max_rows": 50000
    },
    {
      "format_id": "json",
      "label": "JSON",
      "mime_type": "application/json",
      "max_rows": 100000
    }
  ]
}

Preview how many rows an export config would produce

{
  "org_id": "org_kNr8aQ",
  "entity_types": [
    "users",
    "activities"
  ],
  "date_from": "2026-01-01",
  "date_to": "2026-03-26",
  "include_sub_orgs": true
}

{
  "data": {
    "estimated_row_count": 501,
    "breakdown": {
      "users": 184,
      "activities": 317
    }
  }
}

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}