List Export items

List Export items

GET https://api.ocamba.com/v1/hood/exports
Returns a list of Exported items

Tip

Searchable fields are: id, resource, name, description and failed_reason.

Sortable fields are: resource, status, name, size, extension, mime_type, attempt_count, download_count, expire_time, create_time and update_time.

Filterable fields are: all fields.

Rate limits:

  • Burst: 10/s
  • Steady: 150/m

Query parameters

parameters

Response schemas

curl -X GET \
 "https://api.ocamba.com/v1/hood/exports" \
  -H "Authorization: Bearer {TOKEN}"
const url = 'https://api.ocamba.com/v1/hood/exports';
const options = {
  method: 'GET',
  headers: {
    Authorization: `Bearer {TOKEN}`
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
$ch = curl_init("https://api.ocamba.com/v1/hood/exports");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

200 OK

{
  "total": 5,
  "items": [
    {
      "id": "1000000",
      "company_id": "1000001",
      "creator_id": "1000001",
      "resource": "quick-reports",
      "status": "ready",
      "name": "Christmas list - 22.05.2025 11:44:32",
      "description": "help here",
      "size": 125,
      "extension": "csv",
      "mime_type": "text/csv",
      "download_url": "/v1/hood/customers/exports/1000000/download",
      "attempt_count": 1,
      "download_count": 1,
      "failure_reason": "Export failed due to an internal error. Please try again later.",
      "expire_time": "2021-07-30 12:50:13",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

400 Bad Request

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

500 Internal Server Error

{
  "code": 500,
  "title": "Internal server error.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}
Responses