Skip to main content
GET
/
v2
/
roles
List roles
curl --request GET \
  --url https://api.arize.com/v2/roles \
  --header 'Authorization: Bearer <token>'
{
  "roles": [
    {
      "id": "Rol001",
      "name": "Data Scientist",
      "description": "Can read and create datasets and experiments.",
      "permissions": [
        "PROJECT_READ",
        "DATASET_READ",
        "DATASET_CREATE"
      ],
      "is_predefined": false,
      "created_at": "2024-06-01T10:00:00Z",
      "updated_at": "2024-06-01T10:00:00Z"
    },
    {
      "id": "Rol002",
      "name": "Annotator",
      "description": "Can access annotation queues.",
      "permissions": [
        "QUEUE_READ",
        "QUEUE_RECORD_READ",
        "QUEUE_RECORD_ANNOTATE"
      ],
      "is_predefined": true,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "cursor_12345",
    "has_more": true
  }
}

Authorizations

Authorization
string
header
required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Query Parameters

limit
integer
default:50

Maximum items to return

Required range: 1 <= x <= 100
cursor
string

Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.

is_predefined
boolean

Filter roles by predefined status.

  • true - Return only system-defined predefined roles.
  • false - Return only custom (account-defined) roles.

When not specified, returns all roles (both predefined and custom).

Response

Returns a list of role objects.

roles
object[]
required

A list of roles.

pagination
object
required

Pagination metadata for cursor-based navigation.