---
title: "List roles"
method: GET
path: "/v2/roles"
tags: ["Roles"]
---

# List roles

`GET /v2/roles`

List custom and predefined roles for the authenticated user's account.
Results are paginated; use `limit` and `cursor` for subsequent pages.

<Note>This endpoint is in beta, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).</Note>

## Query parameters

- `limit` integer
- `cursor` string
- `is_predefined` boolean

## Response `200`

Returns a list of role objects.

- ListRolesResponse
  - `roles` Role[], required — A list of roles.
    - `id` string, required — Unique identifier for the role.
    - `name` string, required — Human-readable name of the role.
    - `description` string — A brief description of the role's purpose.
    - `permissions` Permission[], required — List of permissions granted by this role. Each value corresponds to a permission identifier (e.g. `PROJECT_READ`, `DATASET_CREATE`).
    - `is_predefined` boolean, required — Whether this role is a system-defined predefined role. Predefined roles cannot be updated or deleted.
    - `created_at` string, date-time, required — Timestamp when the role was created.
    - `updated_at` string, date-time, required — Timestamp when the role was last updated.
  - `pagination` PaginationMetadata, required — Cursor-based pagination metadata. Use `next_cursor` in the subsequent request's `cursor` query parameter.
    - `next_cursor` string — Opaque cursor for fetching the next page. Treat as an unreadable token. Present when `has_more` is true; omitted when `has_more` is false.
    - `has_more` boolean, required — True if another page of results is available.

## Other responses

- `400` — Invalid request
- `401` — Authentication is required
- `403` — Insufficient permissions to access this resource
- `429` — Rate limit exceeded

---

[API](https://skmtc.net/arize-ai/apis/arize-rest-api.md) · [All operations](https://skmtc.net/arize-ai/apis/arize-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arize-ai/arize-rest-api/versions/2ce448f1de13/schema)