List operational-administrator roles for the Account
/portal/v1/accounts/{accountSlug}/admin-rolesAuthentication
Bearer Token
AuthorizationJWT access token. Never send alongside X-API-Key: a request carrying both is refused.
Responses
application/json
items *AdminRoleResponseDto[]
application/json
error *ApiErrorBodyDto
application/json
error *ApiErrorBodyDto
Returned object
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/admin-roles" \ -H "Authorization: Bearer $CANOPY_TOKEN"
{ "items": [ { "id": "string", "name": "string", "description": "string", "is_system": false, "system_key": "string", "is_active": false, "scope": "account", "capabilities": [ "string" ], "assignment_count": 0, "created_at": "2026-04-20T12:00:00.000Z", "updated_at": "2026-04-20T12:00:00.000Z" } ] }
Tell us how we can improve this guide.