1. Docs
  2. API Reference
  3. List the Environments the caller may operate in

List the Environments the caller may operate in

GET/portal/v1/accounts/{accountSlug}/workspace-environments

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Responses

application/json

  • itemsWorkspaceEnvironmentResponseDto[]*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

WorkspaceEnvironmentResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/workspace-environments" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "environment_id": "string",
      "environment_slug": "string",
      "environment_name": "string",
      "application_slug": "string",
      "application_name": "string"
    }
  ]
}
 Related endpoints Was this page helpful?

Tell us how we can improve this guide.

Canopy