Groups

Add Users To Group

post

Create a new group.

Path parameters

group_idstring · uuidRequired

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

emailsstring · email[]Required

Responses

201

Successful Response

application/json

namestring · min: 1 · max: 255Required

Name of the group

idstring · uuidRequired

404

Not found

422

Validation Error

application/json

post/groups/{group_id}/users

HTTPcURLJavaScriptPython

POST /groups/{group_id}/users HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "emails": [
    "[email protected]"
  ],
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "name": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Remove Users From Group

delete

Remove users from a group.

Path parameters

group_idstring · uuidRequired

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

user_idsstring · uuid[]Required

Responses

201

Successful Response

application/json

namestring · min: 1 · max: 255Required

Name of the group

idstring · uuidRequired

404

Not found

422

Validation Error

application/json

delete/groups/{group_id}/users

HTTPcURLJavaScriptPython

DELETE /groups/{group_id}/users HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "user_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "name": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Read Groups

get

f Retrieve a list of groups.

Query parameters

workspace_idstring · uuidRequired

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

namestring · min: 1 · max: 255Required

Name of the group

idstring · uuidRequired

group_typestringRequired

user_countintegerRequired

404

Not found

422

Validation Error

application/json

get/groups

HTTPcURLJavaScriptPython

GET /groups?workspace_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "name": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "group_type": "text",
    "user_count": 1
  }
]

Create New Group

post

Create a new group.

Query parameters

workspace_idstring · uuidRequired

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

namestringRequired

emailsstring · email[]Required

Responses

201

Successful Response

application/json

namestring · min: 1 · max: 255Required

Name of the group

idstring · uuidRequired

404

Not found

422

Validation Error

application/json

post/groups

HTTPcURLJavaScriptPython

POST /groups?workspace_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "name": "text",
  "emails": [
    "[email protected]"
  ],
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "name": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Read Group

get

Get a specific group by ID.

Path parameters

group_idstring · uuidRequired

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

namestring · min: 1 · max: 255Required

Name of the group

idstring · uuidRequired

group_typestringRequired

user_countintegerRequired

404

Not found

422

Validation Error

application/json

get/groups/{group_id}

HTTPcURLJavaScriptPython

GET /groups/{group_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "name": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "group_type": "text",
  "user_count": 1,
  "users": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "email": "text",
      "avatar_url": "text",
      "user_type": "regular",
      "external_id": "text",
      "joined": "2026-07-11T14:55:31.854Z"
    }
  ]
}

Update Existing Group

put

Update a group's name.

Path parameters

group_idstring · uuidRequired

Query parameters

workspace_idstring · uuidRequired

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

namestringRequired

Responses

200

Successful Response

application/json

namestring · min: 1 · max: 255Required

Name of the group

idstring · uuidRequired

404

Not found

422

Validation Error

application/json

put/groups/{group_id}

HTTPcURLJavaScriptPython

PUT /groups/{group_id}?workspace_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "name": "text",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "name": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Delete Existing Group

delete

Delete a group by ID.

Path parameters

group_idstring · uuidRequired

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

delete/groups/{group_id}

HTTPcURLJavaScriptPython

DELETE /groups/{group_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content