Skip to main content
GET
Get Export Job Items

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Include the token in the Authorization header as: Bearer <token>

Path Parameters

jobId
string<uuid>
required

Enter the specific export job ID to retrieve details about the job items included in this export job.

Query Parameters

status
enum<string>

Enter a status to retrieve a list of export job items in the specified state.

Available options:
pending,
in_progress,
failed,
successful,
abandoned
before
string

Lower bound of the page of data to return (cannot be used together with [after] or [offset]).

Pattern: ^[A-Z2-7=~]+$
after
string

Upper bound of the page of data to return (cannot be used together with [before] or [offset]).

Pattern: ^[A-Z2-7=~]+$
offset
integer<int64>

Offset of the page of data to return (cannot be used together with [before] or [after]).

Required range: x >= 0
limit
integer<int32>

The maximum amount of items to return.

Required range: x >= 0
sorting_keys
string[]

The keys to sort the results by.

sorting_order
enum<string>[]

The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.

Available options:
ASC,
ASC_NULLS_FIRST,
ASC_NULLS_LAST,
DESC,
DESC_NULLS_FIRST,
DESC_NULLS_LAST

Response

Export job items found.

data
object[]
required
pagination
object
required