Skip to main content
GET
/
v1
/
export-jobs
Get a list of Export Jobs
curl --request GET \
  --url https://external.pleo.io/v1/export-jobs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "expiresIn": 123,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isInteractive": true,
      "numberOfItems": 123,
      "status": "pending",
      "vendorBasedBookkeeping": true,
      "completedAt": "2023-11-07T05:31:56Z",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "expiredAt": "2023-11-07T05:31:56Z",
      "failureReason": "<string>",
      "failureReasonType": "invalid_configuration",
      "lastUpdatedAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "currentRequestPagination": {
      "parameters": {},
      "after": "<string>",
      "before": "<string>",
      "limit": 123,
      "offset": 123,
      "sortingKeys": [
        "<string>"
      ],
      "sortingOrder": [
        "ASC"
      ]
    },
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>",
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
company_id
string<uuid>

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

​
status
enum<string> | null

Fetch a list of jobs for a specific status.

Available options:
pending,
in_progress,
failed,
completed,
completed_with_errors
​
statuses
enum<string>[]

Fetch a list of jobs for specific statuses.

Available options:
pending,
in_progress,
failed,
completed,
completed_with_errors
​
before
string

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

​
after
string

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

​
offset
integer<int64>

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

​
limit
integer<int32>

The maximum amount of items to return.

​
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

default - application/json;charset=UTF-8

default response

​
data
object[]
required
​
pagination
object
required