List routines

GET

https://api.x.flatfile.com/v1/routines

GET

/v1/routines

1 import requests
2 
3 url = "https://api.x.flatfile.com/v1/routines"
4 
5 querystring = {"runbookId":"us_rb_YOUR_ID"}
6 
7 headers = {
8     "X-Disable-Hooks": "true",
9     "Authorization": "Bearer <token>"
10 }
11 
12 response = requests.get(url, headers=headers, params=querystring)
13 
14 print(response.json())

Try it

200Example0

1 {
2   "data": [
3     {
4       "id": "us_rtn_YOUR_ID",
5       "runbookId": "us_rb_YOUR_ID",
6       "name": "Split Address to Street, City, State, Zip",
7       "config": {
8         "sourceSheetId": "us_sh_YOUR_ID",
9         "destinationSheetId": "us_sh_YOUR_ID",
10         "programId": "us_mp_YOUR_ID"
11       },
12       "ordinal": 1,
13       "type": "JOB",
14       "createdBy": "us_usr_YOUR_ID",
15       "createdAt": "2024-12-05T00:00:00Z",
16       "updatedAt": "2024-12-05T00:00:00Z"
17     }
18   ]
19 }

Returns a list of routines

Authentication

AuthorizationBearer

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

Query parameters

runbookIdstringRequired

Runbook ID

Response

This endpoint returns an object.

datalist of objects

List routines

Authentication

Headers

Query parameters

Response

Errors