1. Docs
  2. API Reference
  3. List roles

List roles

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

Returns the roles defined for the active Application within the current Environment as an unpaginated { items } collection, each enriched with a permission_count. By default only active roles are returned; pass include_inactive=true to include deactivated roles, and filter by type=system or type=custom. 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_roles.viewDeveloper Console

View roles and the permissions they grant. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Query Parameters

include_inactivestring Optional
typestring Optional

Responses

application/json

  • itemsRoleResponseDto[]*

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.

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

RoleResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/roles?include_inactive=value&type=value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "id": "string",
      "application_id": "string",
      "name": "string",
      "description": "string",
      "is_system_role": false,
      "system_key": "string",
      "is_active": false,
      "created_at": "2026-04-20T12:00:00.000Z",
      "updated_at": "2026-04-20T12:00:00.000Z",
      "version": 0,
      "permission_count": 0,
      "member_count": 0
    }
  ]
}
 Related endpoints
POSTCreate a custom role
GETGet a role
PATCHUpdate a role
DELETEDelete a role
GETGet permissions for a role
PUTReplace permissions on a role
 Was this page helpful?

Tell us how we can improve this guide.

Canopy