Skip to main content
Create a new group within an organization. The authenticated user automatically becomes the owner of the newly created group.

Path Parameters

org_id
string
required
The unique identifier of the organization where the group will be created.

Body Parameters

name
string
Unique URL-friendly identifier for the group within the organization. Must be unique within the organization.If not provided but title is provided, the name will be auto-generated from the title by converting it to a slug format.
title
string
required
Display name of the group. This is the human-readable name shown in the UI.
metadata
object
Arbitrary metadata to associate with the group as key-value pairs. Can be used to store additional information about the group.Example: {"department": "engineering", "cost_center": "1234"}

Response

group
object
The created group object.
curl -X POST 'https://frontier.example.com/v1beta1/organizations/org_123/groups' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Engineering Team",
    "name": "engineering-team",
    "metadata": {
      "department": "engineering",
      "location": "us-west"
    }
  }'
{
  "group": {
    "id": "grp_123456789",
    "name": "engineering-team",
    "title": "Engineering Team",
    "org_id": "org_123",
    "metadata": {
      "department": "engineering",
      "location": "us-west"
    },
    "created_at": "2023-06-20T15:45:00Z",
    "updated_at": "2023-06-20T15:45:00Z",
    "members_count": 1
  }
}

Build docs developers (and LLMs) love