API reference

Projects

Projects and their milestones. A project is the unit almost everything else hangs off: tasks, risks, issues and financial entries all reference one.

Operations

GET/v1/projectsprojects.read
Every project in the organisation.
POST/v1/projectsprojects.manage
Create a project.
GET/v1/projects/:idprojects.read
One project.
PATCH/v1/projects/:idprojects.manage
Change a project.
GET/v1/projects/:id/milestonesprojects.read
A project's milestones.
POST/v1/projects/:id/milestonesprojects.manage
Add a milestone.
PATCH/v1/milestones/:idprojects.manage
Change a milestone.

Example

bash

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

Fields

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

Required

Field	Type	Notes
name	string	What the project is called.
budget	number	Required. Send 0 if it is not budgeted.
startDate	YYYY-MM-DD
endDate	YYYY-MM-DD

Scope

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