GET
/role_sets/{role_set_key_or_id}Get a role set
Retrieves a role set by its key or ID, including its roles and organization-member defaults. Use role_set_key_or_id to identify the role set; the response also includes its type and creation and update timestamps.
role_set_key_or_idstringrequired
The key or ID of the role set to retrieve.
200Returns the role set, including its identifier, name, key, roles, default and creator roles, type, timestamps, and any active migration information.
objectstringrequired
idstringrequired
The unique identifier of the role set
namestringrequired
The name of the role set
keystringrequired
A unique key for the role set (e.g., "role_set:default")
descriptionstringrequired
Optional description of the role set
rolesarray<object>required
The list of roles in this role set
default_roleobjectoptional
The default role assigned to new organization members
creator_roleobjectoptional
The role assigned to the creator of an organization
typestringrequired
The type of the role set ("initial" or "custom")
role_set_migrationobjectoptional
Active migration information, only present when status is "enqueued" or "in_progress"
created_atintegerrequired
Unix timestamp of role set creation
updated_atintegerrequired
Unix timestamp of last role set update
401Returned when authentication is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Returned when authorization is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Returned when the role set cannot be found.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
Error handling
The role_set_key_or_id path parameter must identify an existing role set by its key or ID. A 401 is returned when authentication is invalid, a 403 when authorization is invalid, and a 404 when the role set cannot be found.