Skip to main content
GET
/
v1
/
user
List users
curl --request GET \
  --url https://api.braintrust.dev/v1/user \
  --header 'Authorization: Bearer <token>'
{
  "objects": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "given_name": "<string>",
      "family_name": "<string>",
      "email": "<string>",
      "avatar_url": "<string>",
      "created": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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.

Query Parameters

​
limit
integer | null

Limit the number of objects to return

Required range: x >= 0
​
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

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

​
given_name

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

​
family_name

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

​
email

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

​
org_name
string

Filter search results to within a particular organization

Response

Returns a list of user objects

​
objects
object[]
required

A list of user objects