List schedules
curl --request POST \
--url 'https://api.flashcat.cloud/schedule/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"p": 1,
"limit": 20,
"query": "production",
"is_my_team": true
}
'import requests
url = "https://api.flashcat.cloud/schedule/list?app_key="
payload = {
"p": 1,
"limit": 20,
"query": "production",
"is_my_team": True
}
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({p: 1, limit: 20, query: 'production', is_my_team: true})
};
fetch('https://api.flashcat.cloud/schedule/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/schedule/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([
'p' => 1,
'limit' => 20,
'query' => 'production',
'is_my_team' => true
]),
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/schedule/list?app_key="
payload := strings.NewReader("{\n \"p\": 1,\n \"limit\": 20,\n \"query\": \"production\",\n \"is_my_team\": true\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/schedule/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"p\": 1,\n \"limit\": 20,\n \"query\": \"production\",\n \"is_my_team\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/schedule/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 \"p\": 1,\n \"limit\": 20,\n \"query\": \"production\",\n \"is_my_team\": true\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"id": 5789640530410,
"name": "test-000001",
"account_id": 2451002751131,
"group_id": 4291079133131,
"time_zone": "Asia/Shanghai",
"disabled": 0,
"create_at": 1766110836,
"create_by": 2476123212131,
"update_at": 1775205795,
"update_by": 2476123212131,
"layers": null,
"schedule_layers": null,
"final_schedule": {
"layer_name": "",
"name": "",
"mode": 0,
"schedules": null
},
"notify": {
"advance_in_time": 300,
"fixed_time": null,
"by": {
"follow_preference": false,
"personal_channels": [
"email"
]
},
"webhooks": [
{
"type": "feishu_app",
"settings": {
"token": "",
"alias": "",
"data_source_id": 5427276014131,
"chat_ids": [
"oc_60a6dc4c6e4e5cbc4934ef08aa7ff76d"
],
"verify_token": "",
"sign_secret": ""
}
}
]
},
"schedule_id": 5789640530410,
"schedule_name": "test-000001",
"team_id": 4291079133131,
"description": "abc",
"layer_schedules": null,
"status": 0,
"cur_oncall": null,
"next_oncall": null
},
{
"id": 5432326025106,
"name": "test-2509300001",
"account_id": 2451002751131,
"group_id": 2477033058131,
"time_zone": "",
"disabled": 0,
"create_at": 1759132037,
"create_by": 2476123212131,
"update_at": 1775207501,
"update_by": 2476123212131,
"layers": null,
"schedule_layers": null,
"final_schedule": {
"layer_name": "",
"name": "",
"mode": 0,
"schedules": null
},
"notify": {
"advance_in_time": 300,
"fixed_time": null,
"by": {
"follow_preference": true,
"personal_channels": null
},
"webhooks": null
},
"schedule_id": 5432326025106,
"schedule_name": "test-2509300001",
"team_id": 2477033058131,
"description": "",
"layer_schedules": null,
"status": 0,
"cur_oncall": null,
"next_oncall": null
}
],
"total": 41
}
}{
"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."
}
}Schedules
List schedules
List on-call schedules with filters and pagination; pass start and end to also compute shifts.
POST
/
schedule
/
list
List schedules
curl --request POST \
--url 'https://api.flashcat.cloud/schedule/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"p": 1,
"limit": 20,
"query": "production",
"is_my_team": true
}
'import requests
url = "https://api.flashcat.cloud/schedule/list?app_key="
payload = {
"p": 1,
"limit": 20,
"query": "production",
"is_my_team": True
}
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({p: 1, limit: 20, query: 'production', is_my_team: true})
};
fetch('https://api.flashcat.cloud/schedule/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/schedule/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([
'p' => 1,
'limit' => 20,
'query' => 'production',
'is_my_team' => true
]),
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/schedule/list?app_key="
payload := strings.NewReader("{\n \"p\": 1,\n \"limit\": 20,\n \"query\": \"production\",\n \"is_my_team\": true\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/schedule/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"p\": 1,\n \"limit\": 20,\n \"query\": \"production\",\n \"is_my_team\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/schedule/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 \"p\": 1,\n \"limit\": 20,\n \"query\": \"production\",\n \"is_my_team\": true\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"id": 5789640530410,
"name": "test-000001",
"account_id": 2451002751131,
"group_id": 4291079133131,
"time_zone": "Asia/Shanghai",
"disabled": 0,
"create_at": 1766110836,
"create_by": 2476123212131,
"update_at": 1775205795,
"update_by": 2476123212131,
"layers": null,
"schedule_layers": null,
"final_schedule": {
"layer_name": "",
"name": "",
"mode": 0,
"schedules": null
},
"notify": {
"advance_in_time": 300,
"fixed_time": null,
"by": {
"follow_preference": false,
"personal_channels": [
"email"
]
},
"webhooks": [
{
"type": "feishu_app",
"settings": {
"token": "",
"alias": "",
"data_source_id": 5427276014131,
"chat_ids": [
"oc_60a6dc4c6e4e5cbc4934ef08aa7ff76d"
],
"verify_token": "",
"sign_secret": ""
}
}
]
},
"schedule_id": 5789640530410,
"schedule_name": "test-000001",
"team_id": 4291079133131,
"description": "abc",
"layer_schedules": null,
"status": 0,
"cur_oncall": null,
"next_oncall": null
},
{
"id": 5432326025106,
"name": "test-2509300001",
"account_id": 2451002751131,
"group_id": 2477033058131,
"time_zone": "",
"disabled": 0,
"create_at": 1759132037,
"create_by": 2476123212131,
"update_at": 1775207501,
"update_by": 2476123212131,
"layers": null,
"schedule_layers": null,
"final_schedule": {
"layer_name": "",
"name": "",
"mode": 0,
"schedules": null
},
"notify": {
"advance_in_time": 300,
"fixed_time": null,
"by": {
"follow_preference": true,
"personal_channels": null
},
"webhooks": null
},
"schedule_id": 5432326025106,
"schedule_name": "test-2509300001",
"team_id": 2477033058131,
"description": "",
"layer_schedules": null,
"status": 0,
"cur_oncall": null,
"next_oncall": null
}
],
"total": 41
}
}{
"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
- Sorted by creation time, newest first.
querymatches the schedule name or description as a substring. is_my_team: truekeeps schedules owned by the caller’s teams, optionally narrowed byteam_ids; whenteam_idsshares no team with the caller, or the caller belongs to no team, the list is empty.is_my_manage: truekeeps schedules created by the caller plus those owned by the caller’s teams (narrowed byteam_ids; team IDs outside the caller’s teams are ignored). The two cannot both be true.- Without
start/end, items carry stored configuration only (layers,schedule_layers,cur_oncall,next_oncallarenull). With both set,layers,schedule_layers,final_schedule,cur_oncallandnext_oncallare computed;layer_schedulesstaysnullhere. startandendare 10-digit Unix timestamps in seconds;endmust be afterstartand at most 45 days later. Sendingendwithoutstartis rejected.- Callers who cannot edit a schedule (not the account owner or an admin, its creator, or a member of its team) get
notify.imvalues and each webhook’stoken,verify_tokenandsign_secretas empty strings.
Authorizations
Body
application/json
Schedule list filters. limit defaults to 10 and is capped at 100; p defaults to 1. is_my_team and is_my_manage cannot both be true.
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?