Skip to main content
POST
Create a worker group

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Body

application/json

Request payload for creating a new worker group.

name
string
required

Name of the worker group. Must be unique within the organization.

Required string length: 1 - 255
Example:

"Document Review Team"

description
string | null

Optional description of the worker group.

Example:

"Team responsible for reviewing incoming documents."

member_user_ids
string<uuid>[]

List of user UUIDs to add as members when creating the group.

Example:

Response

Worker group created successfully

Response model for worker group detail operations (includes member list).

created_at
string<date-time>
required
id
string<uuid>
required
member_count
integer
required

Number of users currently in this worker group.

Example:

5

modified_by
string
required
name
string
required

Name of the worker group.

Example:

"Document Review Team"

organization_id
string<uuid>
required

UUID of the organization this worker group belongs to.

Example:

"550e8400-e29b-41d4-a716-446655440000"

updated_at
string<date-time>
required
description
string | null

Description of the worker group.

Example:

"Team responsible for reviewing incoming documents."

members
UserSummary · object[]

List of users currently in this worker group.