For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Community Create Account Sign in

API Reference Environments

Get an environment

GET

https://api.x.flatfile.com/v1/environments/:environmentId

GET

/v1/environments/:environmentId

$ curl https://api.x.flatfile.com/v1/environments/us_env_YOUR_ID \
>      -H "X-Disable-Hooks: true" \
>      -H "Authorization: Bearer <token>"

1 {
2   "data": {
3     "id": "us_env_YOUR_ID",
4     "accountId": "us_acc_YOUR_ID",
5     "name": "dev",
6     "isProd": false,
7     "guestAuthentication": [
8       "magic_link"
9     ],
10     "features": {},
11     "metadata": {},
12     "namespaces": [
13       "default"
14     ]
15   }
16 }

Returns a single environment

Was this page helpful?

Update an environment

Overview
API Reference

Community Create Account Sign in

Authentication

AuthorizationBearer

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

Path parameters

environmentIdstringRequired

ID of the environment to return. To fetch the current environment, pass current

Headers

X-Disable-Hooks"true"Required

Response

This endpoint returns an object.

dataobject

Errors

400

Bad Request Error

404

Not Found Error