Skip to content

workforceGroups

Workforce module · 5 operations

List workforce group rows

GET/groups

A group space by department, project, crew or custom audience, with its own chat and files. Returns a cursor page of workforce group rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a workforce group

POST/groups

A group space by department, project, crew or custom audience, with its own chat and files. Creates a workforce group. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a workforce group

GET/groups/{id}

A group space by department, project, crew or custom audience, with its own chat and files. Returns one workforce group with its `ETag`. A workforce group the caller may not see returns 404.

Update a workforce group

PATCH/groups/{id}

A group space by department, project, crew or custom audience, with its own chat and files. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Archive a group

POST/groups/{id}/archive

Archives the group; it keeps its history and takes no new messages. Archiving is final. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.