List agents

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

{
  "data": [
    {
      "accountId": "us_acc_YOUR_ID",
      "createdAt": "2023-10-30T16:59:45.735Z",
      "environmentId": "us_env_YOUR_ID",
      "id": "us_ag_YOUR_ID",
      "updatedAt": "2023-10-30T16:59:45.735Z",
      "compiler": "js",
      "slug": "default",
      "source": "module.exports = { routeEvent: async (...args) => { console.log(args) } }",
      "topics": [
        "workbook:updated"
      ],
      "options": {
        "namespace": "space:blue"
      }
    }
  ],
  "pagination": {
    "currentPage": 3,
    "pageCount": 50,
    "totalCount": 100
  }
}

Authentication

AuthorizationBearer

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

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 objects

paginationobject

pagination info

List agents

Authentication

Headers

Query parameters

Response

Authentication

Headers

Query parameters

Response

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

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	"slug": "default",
11	"source": "module.exports = { routeEvent: async (...args) => { console.log(args) } }",
12	"topics": [
13	"workbook:updated"
14	],
15	"options": {
16	"namespace": "space:blue"
17	}
18	}
19	],
20	"pagination": {
21	"currentPage": 3,
22	"pageCount": 50,
23	"totalCount": 100
24	}
25	}