Vee3

List Clerk role sets

List role sets in a connected Clerk application.

← All Clerk endpoints · Capability overview

GET/v1/clerk/role-sets

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

5 tokens

List role sets in 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.list_role_sets
Parameters5 fields
clerk_instance_idstringOptional

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

limitintegerOptional

Maximum number of results to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of results to skip before returning.

Default: 0 · min 0

querystringOptional

Search by name or key.

order_bystringOptional

Sort order with optional + or - prefix (for example -created_at or name). Defaults to -created_at.

Response36 fields
role_setsarrayitems
34 fields

Role sets in the connected Clerk application.

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.

total_countinteger

Total number of role sets.

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