Skip to main content
POST
Take next available work in a project

Authorizations

x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Query Parameters

projectId
string
required

Project to scope the take-next pools to.

Response

Polymorphic result envelope. type discriminates: GROUP (a group was claimed, group set), TASK (a task was claimed, task set), EMPTY (nothing assignable, reason and message set). EMPTY reasons: no_work (pool empty), excluded_by_team_filter (pool has candidates but the team filter discarded them all), claim_race (candidates existed but every one was claimed concurrently).

type
enum<string>
required

Result discriminator.

Available options:
GROUP,
TASK,
EMPTY
group
object

Present when type=GROUP.

message
string

Human-readable string the UI may display directly. Present when type=EMPTY.

reason
enum<string>

Present when type=EMPTY.

Available options:
no_work,
excluded_by_team_filter,
claim_race
task
object

Present when type=TASK.