Skip to main content
DELETE
Delete group

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.

Path Parameters

group_id
string<uuid>
required

Group id

Response

Returns the deleted group object

A group is a collection of users which can be assigned an ACL

Groups can consist of individual users, as well as a set of groups they inherit from

id
string<uuid>
required

Unique identifier for the group

org_id
string<uuid>
required

Unique id for the organization that the group belongs under

It is forbidden to change the org after creating a group

name
string
required

Name of the group

user_id
string<uuid> | null

Identifies the user who created the group

created
string<date-time> | null

Date of group creation

description
string | null

Textual description of the group

deleted_at
string<date-time> | null

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

member_users
string<uuid>[] | null

Ids of users which belong to this group

member_groups
string<uuid>[] | null

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