Vee3

Get Clerk role set

Retrieve a role set by id from a connected Clerk application.

← All Clerk endpoints · Capability overview

GET/v1/clerk/role-sets/{role_set_id}

https://api.vee3.io/v1/clerk/role-sets/{role_set_id}

3 tokens

Retrieve a role set by id from a connected Clerk application.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.get_role_set
Parameters2 fields
clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

role_set_idstringRequired

Clerk role set id or key to retrieve, update, or modify.

Response35 fields
role_setobject
34 fields

Role set summary.

idstring

Clerk role set id.

namestring

Role set display name.

keystring

Role set key.

descriptionstring

Role set description.

rolesarrayitems
8 fields

Roles included in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

default_roleobject
8 fields

Default role for new members in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

creator_roleobject
8 fields

Role assigned to organization creators in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

typestring

Role set type.

created_atinteger

Unix timestamp in milliseconds when the role set was created.

updated_atinteger

Unix timestamp in milliseconds when the role set was last updated.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required