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

# List roles

`GET /v1/role`

List out all roles. The roles are sorted by creation date, with the most recently-created roles coming first

## Query parameters

- `limit` integer, nullable — Limit the number of objects to return
- `starting_after` string, uuid — Pagination cursor id. For example, if the final item in the last page you fetched had an id of `foo`, pass `starting_after=foo` to fetch the next page. Note: you may only pass one of `starting_after` and `ending_before`
- `ending_before` string, uuid — Pagination cursor id. For example, if the initial item in the last page you fetched had an id of `foo`, pass `ending_before=foo` to fetch the previous page. Note: you may only pass one of `starting_after` and `ending_before`
- `ids` union — Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times
  - string, uuid
  - string[]
- `role_name` string — Name of the role to search for
- `org_name` string — Filter search results to within a particular organization

## Response `200`

Returns a list of role objects

- object
  - `objects` Role[], required — A list of role objects
    - `id` string, uuid, required — Unique identifier for the role
    - `org_id` string, uuid, nullable — Unique id for the organization that the role belongs under A null org_id indicates a system role, which may be assigned to anybody and inherited by any other role, but cannot be edited. It is forbidden to change the org after creating a role
    - `user_id` string, uuid, nullable — Identifies the user who created the role
    - `created` string, date-time, nullable — Date of role creation
    - `name` string, required — Name of the role
    - `description` string, nullable — Textual description of the role
    - `deleted_at` string, date-time, nullable — Date of role deletion, or null if the role is still active
    - `member_permissions` object[], nullable — (permission, restrict_object_type) tuples which belong to this role
      - `permission` 'create' | 'read' | 'update' | 'delete' | 'create_acls' | 'read_acls' | 'update_acls' | 'delete_acls', required — Each permission permits a certain type of operation on an object in the system Permissions can be assigned to to objects on an individual basis, or grouped into roles
      - `restrict_object_type` 'organization' | 'project' | 'experiment' | 'dataset' | 'prompt' | 'prompt_session' | 'group' | 'role' | 'org_member' | 'project_log' | 'org_project', nullable — The object type that the ACL applies to
    - `member_roles` string[], nullable — Ids of the roles this role inherits from An inheriting role has all the permissions contained in its member roles, as well as all of their inherited permissions

## Other responses

- `400` — The request was unacceptable, often due to missing a required parameter
- `401` — No valid API key provided
- `403` — The API key doesn’t have permissions to perform the request
- `429` — Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
- `500` — Something went wrong on Braintrust's end. (These are rare.)

---

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