跳转到主要内容
POST
/
schedule
/
list
查询值班表列表
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
}
'
{
  "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
  }
}

​
限制说明

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

响应

成功

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

​
request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
必填

值班表列表响应。