List jobs | Flatfile | API Reference

1 import { FlatfileClient } from "@flatfile/api"; 2 3 const client = new FlatfileClient({ token: "YOUR_TOKEN" }); 4 await client.jobs.list({ 5 environmentId: "us_env_YOUR_ID", 6 spaceId: "us_sp_YOUR_ID" 7 });

1 { 2 "data": [ 3 { 4 "createdAt": "2023-10-30T20:04:28.556Z", 5 "createdBy": "us_usr_YOUR_ID", 6 "id": "us_jb_YOUR_ID", 7 "operation": "submitAction", 8 "source": "us_wb_YOUR_ID", 9 "type": "workbook", 10 "updatedAt": "2023-10-30T20:04:32.075Z", 11 "config": {}, 12 "destination": "us_wb_YOUR_ID", 13 "environmentId": "us_env_YOUR_ID", 14 "fileId": "us_fl_YOUR_ID", 15 "finishedAt": "2023-10-30T20:04:32.074Z", 16 "info": "Starting job to submit action to webhook.site", 17 "input": {}, 18 "managed": true, 19 "mode": "foreground", 20 "outcome": { 21 "message": "Data was successfully submitted to Webhook.site. Go check it out at https://example.site/example." 22 }, 23 "progress": 100, 24 "startedAt": "2023-10-30T20:04:29.453Z", 25 "status": "complete", 26 "subject": { 27 "type": "resource", 28 "id": "us_wb_YOUR_ID" 29 }, 30 "trigger": "immediate" 31 } 32 ], 33 "pagination": { 34 "currentPage": 3, 35 "pageCount": 50, 36 "totalCount": 100 37 } 38 }

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:

excludeChildJobsbooleanOptional

When true, only top-level jobs will be returned unless a parentId is specified

Response

This endpoint returns an object.

datalist of objects

paginationobjectOptional

pagination info

Headers

Query parameters

Response