Skip to main content
POST
Preview

Authorizations

Authorization
string
header
required

An API key from Settings, API Keys. A caller on this machine needs none.

Body

application/json
starts_at
string

ISO 8601; defaults to now

Minimum string length: 1
every
string | null

How often it repeats: 15m, 1h, 1d, 2w, 1 month. Null fires once. With no starts_at this is dateless. The anchor is snapped to the unit, so 1h means the top of every hour.

Maximum string length: 32
Example:

"1d"

days
enum<string>[] | null

Weekdays it may fall on, narrowing the cadence. Weekdays-only is ["mo","tu","we","th","fr"]

Available options:
mo,
tu,
we,
th,
fr,
sa,
su
monthday
integer | null

Day of the month, or -1 for its last day. The one thing starts_at cannot say, since months differ in length

Required range: -31 <= x <= 31
nth
integer | null

Which match to keep. With days ["fr"] and a monthly cadence, -1 is the last Friday of the month

Required range: -53 <= x <= 53
until
string | null

Stop repeating after this date. Null repeats forever. Not ends_at: this is when the event stops recurring at all.

count
integer
default:5
Required range: 1 <= x <= 100

Response

Upcoming occurrences

occurrences
string[]
required

ISO 8601, earliest first

rule
string | null

The cadence as an iCalendar RRULE, for reference