API reference

Tasks

The unit of work. Tasks belong to a project, are assigned to a person, and carry a due date. All three are required, because a task without them cannot be chased.

Operations

GET/v1/taskstasks.read
Tasks, optionally filtered by projectId or status.
POST/v1/taskstasks.manage
Create a task.
GET/v1/tasks/:idtasks.read
One task.
PATCH/v1/tasks/:idtasks.manage
Change a task.
DEL/v1/tasks/:idtasks.manage
Delete a task.
GET/v1/tasks/:id/commentstasks.read
A task's comments.
POST/v1/tasks/:id/commentstasks.manage
Comment on a task.

Example

bash

curl https://gateway.octopusoperations.co.za/v1/tasks \
  -H "Authorization: Bearer $OCTOPUS_API_KEY"

Fields

These are required when creating a task. Omit one and the 400 names it exactly, Octopus will not invent a plausible value on your behalf.

Required

Field	Type	Notes
title	string
projectId	uuid	The project this belongs to.
assigneeId	uuid	Who is doing it. A user id, from /v1/personnel.
dueDate	YYYY-MM-DD

Optional

Field	Type	Notes
status	string	todo · in_progress · blocked · complete. Defaults to todo.
priority	string	low · medium · high.
description	string
milestoneId	uuid

Scope

Reading needs tasks.read. Anything that changes data needs the matching .manage scope, which grants the .read alongside it. See scopes & permissions.