Download Export File

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

Downloads the file generated by a completed asynchronous export job.

Path parameters

  • id integer Required

    Export Job ID

Responses

  • 200

    Export file (JSON or CSV)
  • 400 application/json

    Invalid export ID or export not ready

    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
  • 500 application/json

    Export file path not found or file missing on disk

    Hide response attribute Show response attribute object
    • * string Additional properties
GET /api/v1/exports/{id}/download 
curl \
 --request GET 'http://api.example.com/api/v1/exports/{id}/download' \
 --header "Authorization: $API_KEY"
Response examples (200) 
string
Response examples (400) 
{
  "additionalProperty1": "string",
  "additionalProperty2": "string"
}
Response examples (401) 
{
  "additionalProperty1": "string",
  "additionalProperty2": "string"
}
Response examples (404) 
{
  "additionalProperty1": "string",
  "additionalProperty2": "string"
}
Response examples (500) 
{
  "additionalProperty1": "string",
  "additionalProperty2": "string"
}