Skip to content
Skunivo Help Center

Get a report export job

GET
/v1/organizations/{organizationId}/report-exports/{exportId}

API key scope: reports:export. Completed jobs are downloadable while their temporary snapshot has not expired.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
exportId
required
string

Header Parameters

Section titled “Header Parameters”
X-Request-Id
string

Optional client request id returned in structured errors.

Responses

Section titled “Responses”

200

Section titled “200”

Report export job found.

Media typeapplication/json
object
id
required
string format: uuid
organizationId
required
string format: uuid
environment
required
string
Allowed values: live test
reportType
required
string
Allowed values: inventory_snapshot stock_movements operations_summary exceptions
format
required
string
Allowed values: csv xlsx
status
required
string
Allowed values: pending running completed failed
filters
object
key
additional properties
any
rowCount
required

Number of rows captured in the temporary export snapshot.

number
downloadAvailable
required

Whether the completed snapshot is still available for on-demand file generation.

boolean
hasFile
required

Deprecated compatibility alias for downloadAvailable. No server-side file is stored.

boolean
expiresAt
required
string format: date-time
requestedBy
object
completedAt
object
errorCode
object
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "id": "77777777-7777-4777-8777-777777777777",
  "organizationId": "11111111-1111-4111-8111-111111111111",
  "environment": "test",
  "reportType": "inventory_snapshot",
  "format": "csv",
  "status": "completed",
  "filters": {
    "productId": "22222222-2222-4222-8222-222222222222",
    "locationId": "33333333-3333-4333-8333-333333333333"
  },
  "rowCount": 1,
  "downloadAvailable": true,
  "hasFile": true,
  "expiresAt": "2026-07-13T12:00:00.000Z",
  "requestedBy": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "completedAt": "2026-07-06T12:01:00.000Z",
  "errorCode": null,
  "createdAt": "2026-07-06T12:00:00.000Z",
  "updatedAt": "2026-07-06T12:01:00.000Z"
}

403

Section titled “403”

The organization has exhausted its monthly public API request quota.

Media typeapplication/json
Example
{
  "error": {
    "code": "PLAN_LIMIT_EXCEEDED",
    "message": "Plan limit exceeded for api_requests",
    "requestId": "req_123",
    "details": {
      "entitlementKey": "api_requests",
      "scope": "environment",
      "environment": "live",
      "configured": true,
      "limit": "50000",
      "used": "50000",
      "requested": "1",
      "currentPlan": {
        "code": "free",
        "version": 1
      },
      "requiredPlan": {
        "code": "starter",
        "version": 1,
        "requiresOverride": false
      }
    }
  }
}