Skip to main content
POST
List calendar events

Restrictions

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Calendar event list request. When day > 0 month must also be specified. month and day accept 0 to mean "not filtered".

cal_id
string
required

Calendar ID.

year
integer

Year. Defaults to the current year when omitted.

Required range: x >= 2023
month
integer

Month (1-12). 0 means no month filter.

Required range: 0 <= x <= 12
day
integer

Day (1-31). 0 means no day filter.

Required range: 0 <= x <= 31

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
required

Calendar event list response.