BRbraintrustdata
Groups

Get group

Changed on

Get a group object by its id

get/v1/group/{group_id}

Request

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

Path parameters

group_idstring uuid required

Group id

Response

Returns the group object

idstring uuid required

Unique identifier for the group

org_idstring uuid required

Unique id for the organization that the group belongs under

It is forbidden to change the org after creating a group

user_idstring uuid nullable

Identifies the user who created the group

createdstring date-time nullable

Date of group creation

namestring required

Name of the group

descriptionstring nullable

Textual description of the group

deleted_atstring date-time nullable

Date of group deletion, or null if the group is still active

member_usersstring[] nullable

Ids of users which belong to this group

member_groupsstring[] nullable

Ids of the groups this group inherits from

An inheriting group has all the users contained in its member groups, as well as all of their inherited users

Changes

  • ac2727014d93Revision changes
    • breaking

      the response's body became nullable

    • breaking

      the response's body became nullable

    • breaking

      the response's body became nullable

    • breaking

      the response's body became nullable

    • breaking

      the response's body became nullable

  • 44b51ad3239aRevision changes
    • info

      endpoint added