BRbraintrustdata
Roles

List roles

Changed on

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

get/v1/role

Request

  • Base URL
    https://api.braintrust.dev
  • Auth
    • HTTP bearer
    • or none

Query parameters

limitinteger nullable

Limit the number of objects to return

starting_afterstring 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_beforestring 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

string uuid
OR
string[]
role_namestring

Name of the role to search for

org_namestring

Filter search results to within a particular organization

Response

Returns a list of role objects

Changes

  • 8f5039399f77Revision changes
    • breaking

      the //// response's property type changed from string to no type for status

    • info

      added subschema #2 to the //// response property anyOf list for the response status

    • info

      removed the ai_secret enum value from the //// response property for the response status

    • info

      removed the dataset enum value from the //// response property for the response status

    • info

      removed the experiment enum value from the //// response property for the response status

    • info

      removed the group enum value from the //// response property for the response status

    • info

      removed the org_account enum value from the //// response property for the response status

    • info

      removed the org_ai_secret enum value from the //// response property for the response status

    • info

      removed the org_audit_logs enum value from the //// response property for the response status

    • info

      removed the org_member enum value from the //// response property for the response status

    • info

      removed the org_project enum value from the //// response property for the response status

    • info

      removed the organization enum value from the //// response property for the response status

    • info

      removed the project enum value from the //// response property for the response status

    • info

      removed the project_group enum value from the //// response property for the response status

    • info

      removed the project_group_projects enum value from the //// response property for the response status

    • info

      removed the project_log enum value from the //// response property for the response status

    • info

      removed the prompt enum value from the //// response property for the response status

    • info

      removed the prompt_session enum value from the //// response property for the response status

    • info

      removed the role enum value from the //// response property for the response status

  • 877ab1fd2a22Revision changes
    • warning

      added the new project_group_projects enum value to the //// response property for the response status