Jobs

List jobs

GET

Query parameters

environmentIdstringOptional
When provided, only jobs for the given environment will be returned
spaceIdstringOptional
When provided, only jobs for the given space will be returned
workbookIdstringOptional
When provided, only jobs for the given workbook will be returned
fileIdstringOptional
When provided, only jobs for the given file will be returned
parentIdstringOptional
When provided, only jobs that are parts of the given job will be returned
pageSizeintegerOptional
Number of jobs to return in a page (default 20)
pageNumberintegerOptional
Based on pageSize, which page of jobs to return
sortDirectionenumOptional
Sort direction - asc (ascending) or desc (descending)
Allowed values: ascdesc

Response

This endpoint returns an object
data
list of objects
A single unit of work that will execute asynchronously
pagination
objectOptional
pagination info
GET
$curl -G https://api.x.flatfile.com/v1/jobs \
>     -H "Authorization: Bearer <token>" \
>     -d environmentId=us_env_YOUR_ID \
>     -d spaceId=us_sp_YOUR_ID
Response
1{
2  "data": [
3    {
4      "createdAt": "2023-10-30T20:04:28.556Z",
5      "id": "us_jb_YOUR_ID",
6      "operation": "submitAction",
7      "source": "us_wb_YOUR_ID",
8      "type": "workbook",
9      "updatedAt": "2023-10-30T20:04:32.075Z",
10      "destination": "us_wb_YOUR_ID",
11      "environmentId": "us_env_YOUR_ID",
12      "fileId": "us_fl_YOUR_ID",
13      "finishedAt": "2023-10-30T20:04:32.074Z",
14      "info": "Starting job to submit action to webhook.site",
15      "input": {},
16      "managed": true,
17      "mode": "foreground",
18      "outcome": {
19        "message": "Data was successfully submitted to Webhook.site. Go check it out at https://example.site/example."
20      },
21      "progress": 100,
22      "startedAt": "2023-10-30T20:04:29.453Z",
23      "status": "complete",
24      "subject": {
25        "type": "resource",
26        "id": "us_wb_YOUR_ID"
27      },
28      "trigger": "immediate",
29      "config": {}
30    }
31  ],
32  "pagination": {
33    "currentPage": 3,
34    "pageCount": 50,
35    "totalCount": 100
36  }
37}
Built with