Environments
List Environments
Changed onRetrieve the effective environment set for a workspace: the built-in production and staging environments (virtual, locked — present for every workspace with no stored row), plus the organization’s shared environments and the workspace’s own custom environments. Environments resolve per-environment integration configuration.
Requires Workspace Viewer role or above — listing is read-only. Creating, updating and deleting custom environments requires Workspace Owner or Workspace Creator.
Note: Environment APIs are available only with self-hosted Enterprise plans and cloud-hosted plans. Creating custom environments requires a plan that includes the custom-environments feature.
get/api/v3/meta/workspaces/{workspaceId}/environments
Request
- Base URLhttps://app.nocodb.com
- Auth
- API key in header xc-token
- or HTTP bearer
- TypeScripthttps://skmtc.dev/nocodb/apis/nocodb-v3/docs/api/v3/meta/workspaces/:workspaceId/environments/get.tsA function with typed inputs. Its response is checked against the schema.
Path parameters
workspaceIdstring required
Workspace ID
Response
List of environments
Example response
{
"list": [
{
"id": "envabc12345",
"key": "qa",
"title": "QA",
"description": "Pre-release verification",
"color": "#6A7184",
"workspace_id": "w6dw3fo0",
"org_id": "org123",
"created_by": "usr1234567"
}
]
}Changes
- info
endpoint added
- info