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
}
'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{
"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,
"days": {
"2026-05-01": {
"is_off": true,
"event_id": "cale.KyG9XWTCU5CucbwukEVBQ4",
"layer": "custom"
},
"2026-05-02": {
"is_off": true,
"event_id": "non_work.20260502",
"layer": "weekly"
},
"2026-05-09": {
"is_off": false,
"event_id": "zh-cn.china.official.c234057c-fd90-380e-889c-3e3254dd5b01",
"layer": "holiday"
},
"2026-05-11": {
"is_off": false
}
}
}
}{
"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": "AccessDenied",
"message": "Access Denied."
}
}{
"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."
}
}Calendar events
List calendar events
Return a personal calendar’s events for a year, month or day, plus the resolved state of each day.
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
}
'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{
"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,
"days": {
"2026-05-01": {
"is_off": true,
"event_id": "cale.KyG9XWTCU5CucbwukEVBQ4",
"layer": "custom"
},
"2026-05-02": {
"is_off": true,
"event_id": "non_work.20260502",
"layer": "weekly"
},
"2026-05-09": {
"is_off": false,
"event_id": "zh-cn.china.official.c234057c-fd90-380e-889c-3e3254dd5b01",
"layer": "holiday"
},
"2026-05-11": {
"is_off": false
}
}
}
}{
"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": "AccessDenied",
"message": "Access Denied."
}
}{
"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."
}
}Restrictions
| Aspect | Value |
|---|---|
| Rate limits | 1,000 requests/minute; 50 requests/second per account |
| Permissions | None — any valid app_key can call this operation |
Usage
yeardefaults to the current year; withoutmonththe whole year is returned, anddayrequiresmonth.itemsmerges the calendar’s own events (cale.*IDs), one generatednon_work.YYYYMMDDentry per non-working weekday whenworkdaysis set, and the events of the linked holiday calendars;totalcounts all of them.daysgives the resolved state of every day in the scope.- Only personal calendars (
cal_idstarting withcal.) are supported; other IDs returnInvalidParameter.
Authorizations
Body
application/json
Calendar event list request. When day > 0 month must also be specified. month and day accept 0 to mean "not filtered".
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.
Was this page helpful?