v1

latestOpenAPI 3.0.1Apache 2.02026-07-26131220353.8 KB
Export API (v1)

Get a list of Export Jobs

Fetch a list of export jobs

get/v1/export-jobs

Query parameters

company_idstring uuid

Enter the specific company ID for which you want to retrieve the list of export jobs processed before.

status'pending' | 'in_progress' | 'failed' | 'completed' | 'completed_with_errors' nullable

Fetch a list of jobs for a specific status.

statusesstring[]

Fetch a list of jobs for specific statuses.

beforestring

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

afterstring

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

offsetinteger

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

limitinteger

The maximum amount of items to return.

sorting_keysstring[]

The keys to sort the results by.

sorting_orderPageOrder[]

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

Response

default response