Skip to main content
POST
List schedules

Restrictions

Usage

  • Sorted by creation time, newest first. query matches the schedule name or description as a substring.
  • is_my_team: true keeps schedules owned by the caller’s teams, optionally narrowed by team_ids; when team_ids shares no team with the caller, or the caller belongs to no team, the list is empty. is_my_manage: true keeps schedules created by the caller plus those owned by the caller’s teams (narrowed by team_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_oncall are null). With both set, layers, schedule_layers, final_schedule, cur_oncall and next_oncall are computed; layer_schedules stays null here.
  • start and end are 10-digit Unix timestamps in seconds; end must be after start and at most 45 days later. Sending end without start is rejected.
  • Callers who cannot edit a schedule (not the account owner or an admin, its creator, or a member of its team) get notify.im values and each webhook’s token, verify_token and sign_secret as empty strings.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

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.

query
string

Substring matched against the schedule name or description.

p
integer
default:1

Page number (1-indexed).

limit
integer
default:10

Page size. Default 10; values above 100 are treated as 100.

Required range: x <= 100
is_my_team
boolean

Only schedules owned by the caller's teams. When team_ids shares no team with the caller, or the caller belongs to no team, the list is empty.

is_my_manage
boolean

Only schedules owned by the caller's teams or created by the caller. team_ids narrows the team part; team IDs outside the caller's teams are ignored.

team_ids
integer<int64>[]

Only schedules owned by these teams. With is_my_team or is_my_manage, only the teams the caller belongs to are kept.

start
integer<int64>

Window start, 10-digit Unix seconds. Send together with end to compute layers and shifts.

end
integer<int64>

Window end, 10-digit Unix seconds, after start and at most 45 days later. Sending end without start is rejected.

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

Schedule list response.