Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Schedule on-calls

List on-call responders

Lists the on-call responders at a specific time for the schedule with given id in the request.<br> <br> Permissions required: Permission to access to the schedule:

  • the user has read-only administrative right.
  • the schedule's assigned team is one of the teams that the user belongs to.
  • the user is added to a rotation of the schedule as a responder.
  • a team is added to a rotation of the schedule as a responder, and the user is a member of this team.
  • an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation.
  • there is an override to the user in the schedule.
get/api/{cloudId}/v1/schedules/{scheduleId}/on-calls

Path parameters

scheduleIdstring required

ID of the schedule.

Query parameters

flatboolean

When enabled, returns only the user ids of the on-call participants in user type. Otherwise, returns the complete flattening tree for on-calls.

datestring date-time

The date for which the schedule's on-calls are requested.

Response

Returned if the request is successful.

OR