Skip to main content
GET
Get Export Job

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

exportJobId
string<uuid>
required

Export job identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Export job

exportJobId
string<uuid>
required

Export job identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

requestedByUserId
string<uuid>
required

Requesting user identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d"

resource
string
required

Export resource key

Example:

"order"

scopeType
enum<string>
required

Export scope type

Available options:
ORGANIZATION,
COMPANY,
COOPERATIVE,
BKO
Example:

"COMPANY"

format
enum<string>
required

Export file format

Available options:
CSV,
XLSX
Example:

"CSV"

columns
string[]
required

Requested export columns

Minimum array length: 1
Example:
filters
object
required

Requested export filters by field

status
enum<string>
required

Export job status

Available options:
PENDING,
QUEUED,
RUNNING,
COMPLETED,
FAILED,
EXPIRED,
CANCELED
Example:

"COMPLETED"

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
exportScheduledId
string<uuid> | null

Originating export schedule identifier

Example:

null

organizationId
string<uuid> | null

Scoped organization identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b"

companyId
string<uuid> | null

Scoped company identifier

Example:

null

cooperativeId
string<uuid> | null

Scoped cooperative identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c"

fileKey
string | null

Private storage object key

Example:

null

fileName
string | null

Suggested download file name

Example:

null

contentType
string | null

Generated file MIME type

Example:

null

sizeBytes
integer | null

Generated file size in bytes

Example:

null

totalRows
integer | null

Generated row count

Example:

null

failureReason
string | null

Failure reason

Example:

null

deletedAt
string<date-time> | null
expiresAt
string<date-time> | null
finishedAt
string<date-time> | null
startedAt
string<date-time> | null