Get a role

Returns one role. Visible to the agency only if it's a non-internal system role or an agency-scoped custom role belonging to the calling agency.

get/api/v3/roles/{role_id}

Request

Base URL
https://embedded.improvado.io
Auth
HTTP basic
TypeScript
https://skmtc.dev/improvado/apis/improvado-embedded-api-v3/docs/api/v3/roles/:role_id/get.ts
A function with typed inputs. Its response is checked against the schema.

role_idinteger required

Role ID

Role detail

idinteger required

Role ID

titlestring required

Role title (unique within the agency)

descriptionstring required

Optional human-readable description

is_systemboolean required

True for built-in Improvado-managed roles. Read-only — cannot be edited or deleted.

is_internalboolean required

True for internal-only roles (impersonation, guest viewers). These are never listed in the API.

layersobject required

Permissions grouped by product layer. Layer codes match code in the permissions catalog.

user_countinteger required

Number of users currently assigned to this role across the agency.

No recorded changes to this operation across all 1 revision of this API.