OpenMax
Free Trial

Apps API · Tasks

Tasks: 8 endpoints

← All groups

GET /api/v1/issues/{issue_id}/tasks

List issue tasks

Scope: work:task:read · Called with: appToken · operationId: list-issue-tasks

Required app scope: work:task:read.

Returns tasks for an issue. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
issue_id path string (uuid) yes Issue UUID
page query integer (int32) Page number (default: 1)
page_size query integer (int32) Items per page (default: 20, max: 100)
order_by query string Sort expression, e.g. created_at:desc
status query string: pending, assigned, running, done, failed, cancelled Filter by status
include_archived query boolean Include tasks archived through project cascade

Responses

POST /api/v1/projects/{project_id}/issues/{issue_id}/tasks

Create task

Scope: work:task:write · Called with: appToken · operationId: create-task

Required app scope: work:task:write.

Creates a task within an issue. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
project_id path string (uuid) yes Project UUID
issue_id path string (uuid) yes Issue UUID

Request body

application/json · CreateTaskRequestBody

Field Type Required Description
assignee_id string (uuid) Assignee member UUID
blueprint_step_id string (uuid) Blueprint step UUID
depends_on array of string (uuid) Task dependency UUIDs
description string Task description
title string yes Task title

Responses

GET /api/v1/tasks

List tasks

Scope: work:task:read · Called with: appToken · operationId: list-tasks

Required app scope: work:task:read.

Returns filtered tasks. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page query integer (int32) Page number (default: 1)
page_size query integer (int32) Items per page (default: 20, max: 100)
order_by query string Sort expression, e.g. created_at:desc
project_id query string (uuid) Filter by project UUID
issue_id query string (uuid) Filter by issue UUID
status query string: pending, assigned, running, done, failed, cancelled Filter by status
include_archived query boolean Include tasks archived through project cascade

Responses

GET /api/v1/tasks/{task_id}

Get task

Scope: work:task:read · Called with: appToken · operationId: get-task

Required app scope: work:task:read.

Returns a task by ID. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
task_id path string (uuid) yes Task UUID

Responses

POST /api/v1/tasks/{task_id}/claim

Claim task

Scope: work:task:write · Called with: appToken · operationId: claim-task

Required app scope: work:task:write.

Assigns a task to the caller (pending → assigned). Does NOT start work or open an attempt — call start-task for that. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
task_id path string (uuid) yes Task UUID

Responses

POST /api/v1/tasks/{task_id}/reassign

Reassign task

Scope: work:task:write · Called with: appToken · operationId: reassign-task

Required app scope: work:task:write.

Reassigns a task to another member. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
task_id path string (uuid) yes Task UUID

Request body

application/json · ReassignTaskRequestBody

Field Type Required Description
new_assignee_id string (uuid) yes New assignee member UUID

Responses

POST /api/v1/tasks/{task_id}/start

Start task

Scope: work:task:write · Called with: appToken · operationId: start-task

Required app scope: work:task:write.

Starts an assigned task (assigned → running) and opens an attempt. Dependency gate (depends_on all done) is enforced here. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
task_id path string (uuid) yes Task UUID

Responses

POST /api/v1/tasks/{task_id}/transition

Transition task

Scope: work:task:write · Called with: appToken · operationId: transition-task

Required app scope: work:task:write.

Transitions a task to a target status. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
task_id path string (uuid) yes Task UUID

Request body

application/json · TransitionTaskRequestBody

Field Type Required Description
target_status string: done, failed, cancelled yes Terminal target task status

Responses