Get Export Job Status

GET /api/v1/exports/{id}
Bearer auth

Retrieves the status and details of a specific asynchronous export job.

Path parameters

  • id integer Required

    Export Job ID

Responses

  • 200 application/json

    Export job details

    Hide response attributes Show response attributes object
    • completed_at string Required
    • created_at string Required
    • error string Required
    • file_path string Required
    • format string Required
    • id integer Required
    • organization_id integer Required
    • status string Required
    • type string Required
    • updated_at string Required
    • user_id integer Required
  • 400 application/json

    Invalid export ID

    Hide response attribute Show response attribute object
    • * string Additional properties
  • 401 application/json

    Unauthorized (JWT invalid/missing or Org ID not found)

    Hide response attribute Show response attribute object
    • * string Additional properties
  • 404 application/json

    Export not found or doesn't belong to user's org

    Hide response attribute Show response attribute object
    • * string Additional properties
GET /api/v1/exports/{id} 
curl \
 --request GET 'http://api.example.com/api/v1/exports/{id}' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "completed_at": "string",
  "created_at": "string",
  "error": "string",
  "file_path": "string",
  "format": "string",
  "id": 42,
  "organization_id": 42,
  "status": "string",
  "type": "string",
  "updated_at": "string",
  "user_id": 42
}
Response examples (400) 
{
  "additionalProperty1": "string",
  "additionalProperty2": "string"
}
Response examples (401) 
{
  "additionalProperty1": "string",
  "additionalProperty2": "string"
}
Response examples (404) 
{
  "additionalProperty1": "string",
  "additionalProperty2": "string"
}