List environments
Lists the environments the caller can see in the current workspace, with cursor-based pagination.
Last updated:
Lists the environments the caller can see in the current workspace, with cursor-based pagination.
GET /api/v1/environments
Authorization
Requires a signed-in person with this scope: environments:read.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
X-Workspace-Id | header | yes | string (uuid) | The workspace the call acts in. Take it from the workspace list. |
cursor | query | no | string | The cursor returned as nextCursor on a previous page, to read the next one. |
limit | query | no | integer | The page size (default 50, capped at 100). |
Responses
200
The environments.
| Field | Type | Required | Description |
|---|---|---|---|
environments | list of object | yes | |
environments[].environmentId | string (uuid) | yes | |
environments[].name | string | yes | |
environments[].applicationName | string | yes | |
environments[].url | string | yes | |
environments[].ecosystem | string | yes | |
environments[].protected | boolean | yes | |
environments[].requiresApproval | boolean | yes | |
environments[].userId | string | yes | |
environments[].createdAt | string (date-time) | yes | |
environments[].updatedAt | string (date-time) | yes | |
environments[].viewerCapabilities | list of one of PREVIEW_DATA, EDIT_PIPELINE, RUN, MONITOR, MANAGE_ENVIRONMENT, MANAGE_PERMISSIONS, APPROVE_RUNS | no | |
nextCursor | string | no | |
hasMore | boolean | yes |
Example response:
{
"environments": [
{
"environmentId": "2f8b1c6a-9d3e-4f5a-8b7c-1e2d3f4a5b6c",
"name": "Production",
"applicationName": "MyMendixApp",
"url": "https://myapp.mendixcloud.com",
"ecosystem": "ecosystem-1",
"protected": true,
"requiresApproval": true,
"userId": "alex.morgan@example.com",
"createdAt": "2026-01-15T09:00:00Z",
"updatedAt": "2026-09-01T12:00:00Z",
"viewerCapabilities": [
"PREVIEW_DATA",
"RUN",
"MONITOR"
]
}
],
"nextCursor": null,
"hasMore": false
}400
A query value is of the wrong kind (for example a page number that is not a number); the message names the parameter.
| Field | Type | Required | Description |
|---|---|---|---|
message | string | yes | |
status | integer | yes | |
errorCode | string | yes | |
timestamp | string (date-time) | no | |
path | string | no | |
details | object | no |