List agents

GET

1 curl -G https://api.x.flatfile.com/v1/agents \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -d environmentId=us_env_YOUR_ID \
5      -d pageSize=20 \
6      -d pageNumber=1

Play

200Example0

1 {
2   "data": [
3     {
4       "accountId": "us_acc_YOUR_ID",
5       "createdAt": "2023-10-30T16:59:45.735Z",
6       "environmentId": "us_env_YOUR_ID",
7       "id": "us_ag_YOUR_ID",
8       "updatedAt": "2023-10-30T16:59:45.735Z",
9       "compiler": "js",
10       "options": {
11         "namespace": "space:blue"
12       },
13       "slug": "default",
14       "source": "module.exports = { routeEvent: async (...args) => { console.log(args) } }",
15       "topics": [
16         "workbook:updated"
17       ]
18     }
19   ],
20   "pagination": {
21     "currentPage": 3,
22     "pageCount": 50,
23     "totalCount": 100
24   }
25 }

Query parameters

environmentIdstringRequired

Environment ID

isSystembooleanOptional

searchstringOptional

pageSizeintegerOptional

Number of logs to return in a page (default 20)

pageNumberintegerOptional

Based on pageSize, which page of records to return

Response

This endpoint returns an object.

datalist of objectsOptional

paginationobjectOptional

pagination info

Headers

Query parameters

Response