Environments

List Organization Environments

Changed on

Retrieve the organization-level environment set: the built-in production and staging environments (virtual, locked) plus the organization’s own environments. Organization environments are shared by every workspace under the organization; workspace-scoped environments are not included here.

Requires organization membership (Org Viewer or above). Available on cloud-hosted plans with organizations.

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/orgs/{orgId}/environments

Request

Path parameters

orgIdstring required

Organization 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