跳转到主要内容
POST
/
calendar
/
event
/
list
查询日历事件列表
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
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求无 —— 持有有效的 app_key 即可调用

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

日历事件列表请求。day > 0 时必须同时指定 month;month 与 day 为 0 表示不过滤。

cal_id
string
必填

日历 ID。

year
integer

年份,留空时默认当前年。

必填范围: x >= 2023
month
integer

月份(1-12),0 表示不按月过滤。

必填范围: 0 <= x <= 12
day
integer

日(1-31),0 表示不按日过滤。

必填范围: 0 <= x <= 31

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

日历事件列表响应。