Workgroup

Workgroup Object

Field	Type	Description
id	snowflake	the workgroup's id
organisation_id	snowflake	the workgroup's organisation id
name	string	the workgroup's name (max 50 characters)
description	string	a description of the workgroup

Get Workgroup

GET /workgroups/{workgroup.id}

Returns the workgroup object for the specified id.

• Auth: required (OpenID Connect bearer token)
• Permissions: caller must be a member of the owning organisation

Error Responses

Status Code	Description
404	Not found (workgroup does not exist)
403	Forbidden (caller is not a member)

Update Workgroup

PATCH /workgroups/{workgroup.id}

Partially update a workgroup. Only name and description are accepted and will be updated if provided.

• Request body: partial workgroup object (e.g. { "name": "New name", "description": "..." })
• Auth: required
• Permissions: caller must have MANAGE_WORKGROUPS on the owning organisation

Error Responses

Status Code	Description
400	Bad request (invalid input or missing related organisation)
403	Forbidden (insufficient permissions)

Delete Workgroup

DELETE /workgroups/{workgroup.id}

Deletes the workgroup and removes related teams, team members and permission grants.

• Auth: required
• Permissions: caller must have MANAGE_WORKGROUPS

Error Responses

Status Code	Description
400	Bad request (invalid workgroup or organisation)
403	Forbidden (insufficient permissions)