查询值班表列表

返回值班表的分页列表。若同时传入 start 与 end（间隔不超过 45 天），响应会包含计算后的排班分层。

POST /schedule/list

查询值班表列表

cURL

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

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "items": [
      {
        "id": 5789640530410,
        "name": "test-000001",
        "account_id": 2451002751131,
        "group_id": 4291079133131,
        "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,
        "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": "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

值班表列表请求。limit 默认 10、最大 100，p 默认 1。is_my_team 与 is_my_manage 不能同时为 true。

query · string

搜索关键字，匹配值班表名称。

p · integer · 默认值: 1

页码（从 1 开始）。

limit · integer · 默认值: 10

每页条数，默认 10、最大 100。

必填范围: x <= 100

is_my_team · boolean

仅返回当前用户所在团队的值班表。

is_my_manage · boolean

仅返回当前用户在其团队内创建的值班表。

team_ids · integer<int64>[]

按团队 ID 过滤。

start · integer<int64>

与 end 同时传入时，响应会包含计算后的分层值班结果；跨度必须小于 45 天。

end · integer<int64>

窗口结束时间（Unix 秒）。

响应

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