Skip to main content
POST
List my schedules

Restrictions

Usage

  • Lists every enabled schedule in which the calling member appears in any layer, whether or not they are on call in the window. Disabled schedules are skipped.
  • final_schedule keeps only the caller’s shifts: periods where the caller is off duty have group set to null. layers describes the whole schedule; schedule_layers and layer_schedules are null.
  • cur_oncall and next_oncall are always null here; use /schedule/by-person for the caller’s current and next shift.
  • start and end are 10-digit Unix timestamps in seconds; end must be after start and at most 45 days later.
  • 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

Query parameters for listing the current user's schedules. start and end are required 10-digit Unix timestamps in seconds, and the window must not exceed 45 days.

start
integer<int64>
required

Window start (Unix seconds, 10 digits). Required.

end
integer<int64>
required

Window end (Unix seconds, 10 digits). Required. Must be within 45 days of start.

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

Response of /schedule/self and /schedule/infos.