Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Connecting external calendars
    4. Advanced guide
  4. Incidents
    1. Get started
    2. Post mortems
    3. Metadata & Catalog
    4. Screening alerts
    5. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Uptime API
    1. Getting an API token
    2. Monitors
    3. Heartbeats
    4. On-call & incidents
      1. On-call schedule
      2. On-call schedule events
        1. List on-call schedule events GET
        2. Get on-call schedule event GET
        3. Create on-call schedule event POST
        4. Update on-call schedule event PATCH
        5. Remove on-call schedule event DELETE
        6. Bulk update on-call schedule events PUT
        7. Response attributes
      3. On-call schedule rotations
      4. Escalation policies
      5. Escalation policy groups
      6. Severities
      7. Severity groups
      8. Incidents
      9. Comments
    5. Status pages
    6. Metadata
    7. Integrations
    8. Team members

Response attributes

Parameter Type Values
events Array of objects List of events, see event table below

Namespace event

Parameter Type Values
id String The ID of the on-call schedule event.
starts_at String Start time of the event (ISO format)
ends_at String End time of the event (ISO format)
users Array of Strings Array of users (identified by email address) that are on-call during this event.
override Boolean Whether this event is an override. Override events take precedence over regular scheduled events.

Previous article

Bulk update on-call schedule events

Next article

Get an on-call schedule rotation