1. Docs
  2. API Reference
  3. List permission catalog

List permission catalog

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/permissions

Returns the permission catalog for the active Application within the current Environment as an unpaginated { items } collection. Use the optional source query parameter to filter to system (built-in) or custom (caller-defined) permissions; omit it to return both. Requires the rbac.view_roles permission.

Authentication

Bearer TokenAuthorization

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

Requires capability env_permissions.viewDeveloper Console

View the permission catalog. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

Query Parameters

sourcestring Optional

Responses

application/json

  • itemsPermissionResponseDto[]*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

PermissionResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/permissions?source=value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "id": "string",
      "application_id": "string",
      "key": "string",
      "name": "string",
      "description": "string",
      "category": "string",
      "source": "system",
      "created_at": "2026-04-20T12:00:00.000Z",
      "version": 0
    }
  ]
}
 Related endpoints
POSTRegister new permission(s)
POSTExplain a node-scoped authorization decision
GETGet a permission
PATCHUpdate permission metadata
DELETERemove a permission
GETGet where a permission is used
 Was this page helpful?

Tell us how we can improve this guide.

Canopy