Comment on page

Schedules

​Schedules represent an on-call calendar. A schedule has many Events.
Schedules are independent objects. The Team object is responsible for assigning itself a primary schedule and an Escalation Policy.
The Schedule Object
Property
Type
Description
name
string
The name of the schedule
Create a Schedule
POST https://api.pagertree.com/api/v4/schedules
Allowed Parameters
def schedule_params
  params.permit(
    :name
  )
end
Required Parameters
name
Retrieve a Schedule
GET https://api.pagertree.com/api/v4/schedules/:id
Update a Schedule
PUT https://api.pagertree.com/api/v4/schedules/:id
Delete a Schedule
DELETE https://api.pagertree.com/api/v4/schedules/:id
List all Schedules
GET https://api.pagertree.com/api/v4/schedules
Flush a Schedule
Removes all events from the schedule. See flush schedule documentation.
DELETE https://api.pagertree.com/api/v4/schedule/:id/flush
Current On-Call
Returns on-call event attendees for now. (Handles repeating events and rotations)
GET https://api.pagertree.com/api/v4/schedule/:id/current_oncall
Window Events
Return on-call event attendees for a specified time frame. (Handles repeating events and rotations)
Query Parameter
Description
start
UTC string of start time to consider (ex: 2022-10-12 07:00:00)
end
UTC string of end time to consider (ex: 2022-10-12 07:00:00)
GET https://api.pagertree.com/api/v4/schedule/:id/window_events?start=2022-10-12 07:00:00&end=2022-10-13 07:00:00
Events
Return Events that are assigned to this schedule. (Does not handle repeating events and rotations. Unprocessed representation of events.)
GET https://api.pagertree.com/api/v4/schedules/:id/events
​
# example with parameters and operators
GET  https://api.pagertree.com/api/v4/schedules/:id/events?ops=start_datetime:gte,end_datetime:lte&start_datetime=2022-10-12 07:00:00&end_datetime=2022-10-13 07:00:00

Property	Type	Description
name	string	The name of the schedule

Query Parameter	Description
start	UTC string of start time to consider (ex: 2022-10-12 07:00:00)
end	UTC string of end time to consider (ex: 2022-10-12 07:00:00)

Last modified 11mo ago