Skip to main content
POST
Get member on-call status

Restrictions

Usage

  • current is the shift in progress with its real start time; when the member is on call in several schedules at once, the one ending last is returned. next is the earliest upcoming shift. Each is null when nothing is found within 45 days of now.
  • schedules lists the enabled schedules where the member is in at least one layer that has not ended. Disabled schedules are not listed and do not count toward current/next.
  • Any member of the account can be queried; person_id comes from the member list.

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

Member on-call status request

person_id
integer<int64>
required

Member ID whose on-call status is returned.

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

The member's on-call status: the shift in progress, the next one, and every enabled schedule they participate in.