Skip to main content
POST
Get schedule info

Restrictions

Usage

  • start and end are 10-digit Unix timestamps in seconds; end must be after start and at most 45 days later.
  • schedule_layers (and its alias layer_schedules) holds each visible layer’s shifts in the window; final_schedule merges all layers, and a shift whose group is null is a gap with nobody on call.
  • The first computed shift may start before start: a shift already in progress at start is returned with its real start time.
  • cur_oncall is the shift in progress now and next_oncall the next shift with someone on duty; each is null when there is none within 45 days of now, independent of the requested window.
  • An unknown schedule_id returns 400.
  • 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 detail request. start/end set the window for computed shifts; at most 45 days apart.

schedule_id
integer<int64>
required

Schedule ID; obtain it from POST /schedule/list.

start
integer<int64>
required

Preview start timestamp (Unix seconds, 10 digits).

end
integer<int64>
required

Preview end timestamp (Unix seconds, 10 digits).

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

On-call schedule as returned by info, list, infos, self and preview. Which computed fields are filled depends on the endpoint — see each operation's notes.