Skip to main content
GET
Get Export Resource

Authorizations

Authorization
string
header
required

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

Path Parameters

resource
string
required

Stable export resource key

Example:

"order"

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 resource

exportResourceId
string<uuid>
required

Export resource identifier

Example:

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

resource
string
required

Stable export resource key

Example:

"order"

label
string
required

Export resource label

Example:

"Orders"

permission
string
required

Permission required to export the resource

Example:

"export:order"

formats
enum<string>[]
required

Supported export formats

Minimum array length: 1

Export file format

Available options:
CSV,
XLSX
Example:
defaultFormat
enum<string>
required

Export file format

Available options:
CSV,
XLSX
Example:

"CSV"

defaultColumns
string[]
required

Default export columns

Minimum array length: 1
Example:
columns
object[]
required

Allowed export columns

Minimum array length: 1
filters
object[]
required

Allowed export filters

status
enum<string>
required

Export resource status

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

createdAt
string<date-time>
required

Creation timestamp

updatedAt
string<date-time>
required

Last update timestamp

description
string | null

Export resource description

Example:

"Orders by status and period"

maxRows
integer | null

Maximum rows per export

Example:

100000

deletedAt
string<date-time> | null

Soft deletion timestamp