Skip to main content
POST
List schedules

Restrictions

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.