API reference

Calendar

Events, deadlines and reminders. Reads take a window; repeating events are returned as rules rather than as one row per occurrence.

Operations

GET/v1/calendarcalendar.read
Events in a window. Takes from and to as epoch milliseconds.
GET/v1/calendar/seriescalendar.read
Repeating events as rules, one row each.
POST/v1/calendarcalendar.manage
Add a calendar event.
GET/v1/calendar/:idcalendar.read
One calendar event.
PATCH/v1/calendar/:idcalendar.manage
Change a calendar event.
DEL/v1/calendar/:idcalendar.manage
Cancel a calendar event.

Example

bash

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

Fields

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

Required

Field	Type	Notes
title	string
startsAt	epoch ms
endsAt	epoch ms

Optional

Field	Type	Notes
kind	string	meeting · reminder · deadline · milestone.
visibility	string	org · internal · private. Defaults to org.
projectId	uuid
clientId	uuid

Scope

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