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

List permission catalog

GET/api/v1/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 Option A

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

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Query Parameters

sourceenum Optional

Filter by permission origin.

one of "system" · "custom"

Responses

application/json

  • itemsPermissionResponseDto[]*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

PermissionResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/permissions?source=system" \
  -H "X-API-Key: $CANOPY_API_KEY"
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)
GETGet a permission
PATCHUpdate permission metadata
DELETERemove a permission
GETGet where a permission is used
POSTEvaluate authorization
POSTBulk evaluate authorization
POSTExplain a node-scoped authorization decision
 Was this page helpful?

Tell us how we can improve this guide.

Canopy