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

NameInRequiredTypeDescription
X-Workspace-Idheaderyesstring (uuid)The workspace the call acts in. Take it from the workspace list.
cursorquerynostringThe cursor returned as nextCursor on a previous page, to read the next one.
limitquerynointegerThe page size (default 50, capped at 100).

Responses

200

The environments.

FieldTypeRequiredDescription
environmentslist of objectyes
environments[].environmentIdstring (uuid)yes
environments[].namestringyes
environments[].applicationNamestringyes
environments[].urlstringyes
environments[].ecosystemstringyes
environments[].protectedbooleanyes
environments[].requiresApprovalbooleanyes
environments[].userIdstringyes
environments[].createdAtstring (date-time)yes
environments[].updatedAtstring (date-time)yes
environments[].viewerCapabilitieslist of one of PREVIEW_DATA, EDIT_PIPELINE, RUN, MONITOR, MANAGE_ENVIRONMENT, MANAGE_PERMISSIONS, APPROVE_RUNSno
nextCursorstringno
hasMorebooleanyes

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.

FieldTypeRequiredDescription
messagestringyes
statusintegeryes
errorCodestringyes
timestampstring (date-time)no
pathstringno
detailsobjectno