List runbooks

GET

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

GET

/v1/runbooks

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

Try it

200Example0

1 {
2   "data": [
3     {
4       "id": "us_rb_YOUR_ID",
5       "accountId": "us_acc_YOUR_ID",
6       "appId": "us_app_YOUR_ID",
7       "environmentId": "us_env_YOUR_ID",
8       "spaceId": "us_sp_YOUR_ID",
9       "name": "Runbook Name",
10       "config": {
11         "sourceSheetIds": [
12           "us_sh_YOUR_ID"
13         ],
14         "destinationSheetIds": [
15           "us_sh_YOUR_ID"
16         ]
17       },
18       "status": "CREATED",
19       "type": "PREPROCESSING",
20       "createdBy": "us_usr_YOUR_ID",
21       "createdAt": "2024-12-05T18:00:00Z",
22       "updatedAt": "2024-12-05T18:00:00Z"
23     }
24   ]
25 }

Returns a list of runbooks

Authentication

AuthorizationBearer

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

Query Parameters

appIdstringOptional

App ID

environmentIdstringOptional

Environment ID

spaceIdstringOptional

Space ID

Response

This endpoint returns an object.

datalist of objects

List runbooks

Authentication

Headers

Query Parameters

Response

Errors