Skip to main content
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
}
'
{
  "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
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt

Use this file to discover all available pages before exploring further.

​
Restrictions

AspectValue
Rate limits1,000 requests/minute; 50 requests/second per account
PermissionsNone — any valid app_key can call this operation

Authorizations

​
app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Schedule list request. limit defaults to 10 and is capped at 100; p defaults to 1. is_my_team and is_my_manage are mutually exclusive.

​
query
string

Search keyword matched against schedule names.

​
p
integer
default:1

Page number (1-indexed).

​
limit
integer
default:10

Page size. Default 10, max 100.

Required range: x <= 100
​
is_my_team
boolean

Only return schedules whose owning team the current user belongs to.

​
is_my_manage
boolean

Only return schedules created by the current user within their teams.

​
team_ids
integer<int64>[]

Filter by team IDs.

​
start
integer<int64>

When set together with end, computed layer schedules are returned. Span must be less than 45 days.

​
end
integer<int64>

Window end timestamp (Unix seconds).

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.

​
request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
required

Schedule list response.