Skip to main content
POST
/
calendar
/
event
/
list
List calendar events
curl --request POST \
  --url 'https://api.flashcat.cloud/calendar/event/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cal_id": "cal.QiNvtdKs4Wj52kZhT3LafM",
  "year": 2024,
  "month": 5
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "items": [
      {
        "account_id": 2451002751131,
        "creator_id": 2476444212131,
        "cal_id": "cal.QiNvtdKs4Wj52kZhT3LafM",
        "event_id": "cale.KyG9XWTCU5CucbwukEVBQ4",
        "summary": "Test Holiday",
        "description": "A test holiday event",
        "start_at": "2026-05-01",
        "end_at": "2026-05-02",
        "is_off": true,
        "created_at": 1775972034,
        "updated_at": 1775972034
      },
      {
        "account_id": 2451002751131,
        "creator_id": 2451002751131,
        "cal_id": "cal.QiNvtdKs4Wj52kZhT3LafM",
        "event_id": "non_work.20260502",
        "summary": "non-working day (Saturday)",
        "description": "",
        "start_at": "2026-05-02",
        "end_at": "2026-05-03",
        "is_off": true,
        "created_at": 0,
        "updated_at": 0
      }
    ],
    "total": 11
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt

Use this file to discover all available pages before exploring further.

​
Restrictions

AspectValue
Rate limits1,000 requests/minute; 50 requests/second per account
PermissionsNone — any valid app_key can call this operation

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.