查询日历事件列表

返回个人日历在指定年/月/日范围内的事件列表。未同时传入 month 和 day 时返回整年数据。

POST /calendar/event/list

查询日历事件列表

cURL

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
}
'

import requests

url = "https://api.flashcat.cloud/calendar/event/list?app_key="

payload = {
    "cal_id": "cal.QiNvtdKs4Wj52kZhT3LafM",
    "year": 2024,
    "month": 5
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({cal_id: 'cal.QiNvtdKs4Wj52kZhT3LafM', year: 2024, month: 5})
};

fetch('https://api.flashcat.cloud/calendar/event/list?app_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flashcat.cloud/calendar/event/list?app_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cal_id' => 'cal.QiNvtdKs4Wj52kZhT3LafM',
    'year' => 2024,
    'month' => 5
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flashcat.cloud/calendar/event/list?app_key="

	payload := strings.NewReader("{\n  \"cal_id\": \"cal.QiNvtdKs4Wj52kZhT3LafM\",\n  \"year\": 2024,\n  \"month\": 5\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/calendar/event/list?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"cal_id\": \"cal.QiNvtdKs4Wj52kZhT3LafM\",\n  \"year\": 2024,\n  \"month\": 5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/calendar/event/list?app_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cal_id\": \"cal.QiNvtdKs4Wj52kZhT3LafM\",\n  \"year\": 2024,\n  \"month\": 5\n}"

response = http.request(request)
puts response.read_body

200

{
  "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
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InvalidParameter",
    "message": "The specified parameter is not valid."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "Unauthorized",
    "message": "You are unauthorized."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "RequestTooFrequently",
    "message": "Request too frequently."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InternalError",
    "message": "We encountered an internal error, and it has been reported. Please try again later."
  }
}

​

限制说明

项目	说明
速率限制	每个账户 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

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

日历事件列表响应。

Show child attributes