ReferenceAPI
GET
/v1/user

List users

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

Authorization

Authorization
Required
Bearer <token>

Most Braintrust endpoints are authenticated by providing your API key as a header Authorization: Bearer [api_key] to your HTTP request. You can create an API key in the Braintrust organization settings page.

In: header

Query Parameters

limitinteger

Limit the number of objects to return

Minimum: 0

starting_afterstring

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

Format: "uuid"

ending_beforestring

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

Format: "uuid"

idsAny properties in string, array<string>

Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times

idsstring

Format: "uuid"

given_nameAny properties in string, array<string>

Given name of the user to search for. You may pass the param multiple times to filter for more than one given name

given_namestring

family_nameAny properties in string, array<string>

Family name of the user to search for. You may pass the param multiple times to filter for more than one family name

family_namestring

emailAny properties in string, array<string>

Email of the user to search for. You may pass the param multiple times to filter for more than one email

emailstring

org_namestring

Filter search results to within a particular organization

Status codeDescription
200Returns a list of user objects
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something went wrong on Braintrust's end. (These are rare.)
curl -X GET "https://api.braintrust.dev/v1/user?limit=0&starting_after=497f6eca-6276-4993-bfeb-53cbbbba6f08&ending_before=497f6eca-6276-4993-bfeb-53cbbbba6f08&ids=497f6eca-6276-4993-bfeb-53cbbbba6f08&given_name=string&family_name=string&email=string&org_name=string"

{
  "objects": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "given_name": "string",
      "family_name": "string",
      "email": "string",
      "avatar_url": "string",
      "created": "2019-08-24T14:15:22Z"
    }
  ]
}

GET
/v1/user/{user_id}

Get user

Get a user object by its id

Authorization

Authorization
Required
Bearer <token>

Most Braintrust endpoints are authenticated by providing your API key as a header Authorization: Bearer [api_key] to your HTTP request. You can create an API key in the Braintrust organization settings page.

In: header

Path Parameters

user_id
Required
string

User id

Format: "uuid"
Status codeDescription
200Returns the user object
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something went wrong on Braintrust's end. (These are rare.)
curl -X GET "https://api.braintrust.dev/v1/user/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "given_name": "string",
  "family_name": "string",
  "email": "string",
  "avatar_url": "string",
  "created": "2019-08-24T14:15:22Z"
}

Previous

Roles

Next

Views