List Environments

View as Markdown

GET
/workspaces
/:workspace
/environments

Get all environments in specified scope

Request

REQUIRED SCOPES

ENVIRONMENT_READ

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

GET PARAMETERS

project_namestring

Project name to filter project-scoped environments

Example: "my-project"

Response

RESPONSE BODY

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

environmentsShortEnvironmentView[]

Last modified on Apr 22, 2026

Revoke Token Create Environments

Request example

CURL
curl -X GET "https://api.buddy.works/workspaces/:workspace/environments" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json"

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/my-workspace",
  "html_url": "https://my-workspace.buddy.works/environments",
  "environments": [
    {
      "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/environments/3a4KbBQl",
      "html_url": "https://my-workspace.buddy.works/my-project/environments/environment/3a4KbBQl",
      "id": "3a4KbBQl",
      "name": "Production Environment",
      "identifier": "prod-env",
      "tags": [
        "production",
        "stable"
      ],
      "scope": "PROJECT"
    },
    {
      "url": "https://api.buddy.works/workspaces/my-workspace/projects/environments/wPjWOjpE",
      "html_url": "https://my-workspace.buddy.works/environments/environment/wPjWOjpE",
      "id": "wPjWOjpE",
      "name": "Staging Environment",
      "identifier": "staging-env",
      "tags": [
        "staging",
        "testing"
      ],
      "scope": "WORKSPACE"
    }
  ]
}

STATUS
200 OK