View an Export item

View an Export item

GET https://api.ocamba.com/v1/hood/exports/{id}

Retrieves a single Export item by its unique identifier. Use optional query parameters to control the response view and included fields.

Rate limits:

Burst: 10/s
Steady: 150/m

Path parameters

parameters

Query parameters

parameters

Response schemas

GET https://api.ocamba.com/v1/hood/exports/{id} HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
curl -X GET "https://api.ocamba.com/v1/hood/exports/{id}" \
  -H "Authorization: Bearer $TOKEN"
fetch("https://api.ocamba.com/v1/hood/exports/{id}", {
  method: "GET",
  headers: { Authorization: `Bearer ${TOKEN}` }
}).then(r => r.json());
$ch = curl_init("https://api.ocamba.com/v1/hood/exports/{id}");
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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "total": 1,
  "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

HTTP/1.1 400 Bad Request
Content-Type: application/json

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

500 Internal Server Error

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

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

Tip
1
If you don’t know the id, list the Export items to find it.