1. Docs
  2. API Reference
  3. Get a role

Get a role

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

Returns a single role by id, scoped to the active Application and current Environment. Returns 404 when no role with that id exists in the Environment. 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.

Path Parameters

idstring Required

Responses

application/json

  • dataRoleResponseDto*

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.

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/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "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
GETList roles
POSTCreate a custom 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