---
title: "Get a list of role sets"
method: GET
path: "/role_sets"
tags: ["Role Sets"]
---

# Get a list of role sets

`GET /role_sets`

Returns a list of role sets for the instance.
Results can be paginated using the optional `limit` and `offset` query parameters.
The role sets are ordered by descending creation date by default.

## Query parameters

- `query` string
- `order_by` string
- `limit` integer
- `offset` integer

## Response `200`

Success

- RoleSets
  - `data` RoleSet[], required
    - `object` 'role_set', required
    - `id` string, required — The unique identifier of the role set
    - `name` string, required — The name of the role set
    - `key` string, required — A unique key for the role set (e.g., "role_set:default")
    - `description` string, nullable, required — Optional description of the role set
    - `roles` RoleSetItem[], required — The list of roles in this role set
      - `object` 'role_set_item', required
      - `id` string, required — The unique identifier of the role
      - `name` string, required — The name of the role
      - `key` string, required — The key of the role (e.g., "org:admin", "org:member")
      - `description` string, nullable, required — Optional description of the role
      - `members_count` integer, nullable — The number of members assigned to this role within the role set
      - `has_members` boolean, nullable — Whether this role has any members assigned within the role set
      - `created_at` integer, required — Unix timestamp of role creation
      - `updated_at` integer, required — Unix timestamp of last role update
    - `default_role` RoleSetItem — A role within a role set
      - `object` 'role_set_item', required
      - `id` string, required — The unique identifier of the role
      - `name` string, required — The name of the role
      - `key` string, required — The key of the role (e.g., "org:admin", "org:member")
      - `description` string, nullable, required — Optional description of the role
      - `members_count` integer, nullable — The number of members assigned to this role within the role set
      - `has_members` boolean, nullable — Whether this role has any members assigned within the role set
      - `created_at` integer, required — Unix timestamp of role creation
      - `updated_at` integer, required — Unix timestamp of last role update
    - `creator_role` RoleSetItem — A role within a role set
      - `object` 'role_set_item', required
      - `id` string, required — The unique identifier of the role
      - `name` string, required — The name of the role
      - `key` string, required — The key of the role (e.g., "org:admin", "org:member")
      - `description` string, nullable, required — Optional description of the role
      - `members_count` integer, nullable — The number of members assigned to this role within the role set
      - `has_members` boolean, nullable — Whether this role has any members assigned within the role set
      - `created_at` integer, required — Unix timestamp of role creation
      - `updated_at` integer, required — Unix timestamp of last role update
    - `type` 'initial' | 'custom', required — The type of the role set ("initial" or "custom")
    - `role_set_migration` RoleSetMigration — Information about an ongoing role set migration
      - `object` 'role_set_migration', required
      - `id` string, required — The unique identifier of the migration
      - `organization_id` string, nullable — The organization ID if the migration is scoped to a specific organization
      - `instance_id` string, required — The instance ID this migration belongs to
      - `source_role_set_id` string, required — The ID of the source role set being migrated from
      - `dest_role_set_id` string, nullable — The ID of the destination role set being migrated to
      - `trigger_type` string, required — What triggered this migration (e.g., "role_set_deletion", "role_removal")
      - `status` string, required — Current status of the migration (e.g., "enqueued", "in_progress", "completed")
      - `migrated_members` integer, required — Number of members that have been migrated so far
      - `mappings` object, nullable — Role key mappings from source to destination roles
      - `started_at` integer, nullable — Unix timestamp when the migration started
      - `completed_at` integer, nullable — Unix timestamp when the migration completed
      - `created_at` integer, required — Unix timestamp of migration creation
      - `updated_at` integer, required — Unix timestamp of last migration update
    - `created_at` integer, required — Unix timestamp of role set creation
    - `updated_at` integer, required — Unix timestamp of last role set update
  - `total_count` integer, required — Total number of role sets

## Other responses

- `400` — Request was not successful
- `401` — Authentication invalid
- `403` — Authorization invalid
- `422` — Invalid request parameters

---

[API](https://skmtc.net/clerk/apis/clerk-backend-api.md) · [All operations](https://skmtc.net/clerk/apis/clerk-backend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clerk/clerk-backend-api/revisions/cf036e7951d3/schema)