API ReferenceExports

Api Export Jobs Retrieve

Retrieve, update, or delete an export job. PATCH with ``{"status": "paused"}`` pauses an in-progress job. PATCH with ``{"status": "pending"}`` resumes a paused job. Transition validation lives in the serializer; side effects in signals. Superadmin: Can access any export job across all organizations. Regular users: Can only access export jobs in their organization.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Path parameters

idintegerRequired

Response

idintegerRead-only
projectstring or nullRead-only
created_atdatetimeRead-only
updated_atdatetimeRead-only
export_check_point_atdatetime or nullRead-only
exported_chunkslist of anyRead-only
exported_chunk_countintegerRead-only
export_progress_percentagedoubleRead-only
estimated_entry_countintegerRead-only
exported_record_countintegerRead-only
celery_task_idstringRead-only
failed_reasonstringRead-only
warningsanyRead-only
generated_sqlstringRead-only
dispatch_generationintegerRead-only
userinteger or nullRead-only
namestring<=100 characters
statusenum
  • pending - Pending
  • processing - Processing
  • paused - Paused
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
export_formatenum
  • csv - Csv
  • json - Json
  • jsonl - Jsonl
query_paramsany
post_paramsany
list_typestring<=100 characters
source_workflow_version_idstring or null<=64 characters