Community Create Account Sign in

Overview
API Reference

Community Create Account Sign in

API Reference Agents

Get an agent

GET

GET

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

200Example0

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

Path parameters

agentIdstringRequired

Agent ID

Headers

AuthorizationstringRequired

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

X-Disable-Hooks"true"Required

Query parameters

environmentIdstringOptional

Environment ID

Response

This endpoint returns an object.

dataobjectOptional

Errors

Was this page helpful?

List agent versions for an agent