Explore documentation
  1. Welcome to Incidents 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Tag on-call in Slack
    4. Mobile apps ↗
    5. Connecting external calendars
    6. Advanced guide
  4. Incident management
    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. Incidents API
    1. Getting an API token
    2. Monitors
    3. Heartbeats
    4. On-call & incidents
      1. On-call schedule
        1. List on-call schedules GET
        2. Get on-call schedule GET
        3. Create on-call schedule POST
        4. Update on-call schedule PATCH
        5. Remove on-call schedule DELETE
        6. Response attributes
      2. On-call schedule events
      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
    9. Organization roles
    10. Usage
    11. Reporting

Response attributes

Parameter Type Values
data Object Data object. See data object table below.
included Array of Objects Array of on-call user objects. See included array table below.

Namespace data

Parameter Type Values
id String The ID of the on-call schedule.
type String on_call_calendar
attributes Object Attributes object. See below.
attributes.name String Name of the on-call schedule.
attributes.default_calendar Boolean Whether the on-call schedule is the default on-call schedule.
attributes.team_name String The team this on-call schedule is in.
relationships Object Relationships object. See below.
relationships.on_call_users Object On Call Users object. See below.
relationships.on_call_users.data Array of Objects Array of on-call persons.
relationships.on_call_users.data[index].id String Id of the on call person.
relationships.on_call_users.data[index].type String user
relationships.on_call_users.data[index].meta Object Includes the meta for the user.
relationships.on_call_users.data[index].meta.email String tomas@uptime.betterstack.com
relationships.on_call_users.data[index].meta.on_holiday Boolean Whether the on-call person is in holiday mode now, or at the date you asked for. People on holiday stay listed, but we don't alert them until it ends.
relationships.on_call_users.data[index].meta.holiday_ends_at String or null When their holiday ends, as an ISO 8601 date-time in UTC, like 2026-10-26T14:00:00Z. null when they aren't on holiday.

Namespace included[index]

Parameter Type Values
id String Id of the included on-call user.
type String on_call_user
attributes Object Attributes object. See below.
attributes.first_name String First name of the on-call user.
attributes.last_name String Last name of the on-call user.
attributes.email String E-mail of the on-call user.
attributes.phone_numbers Array of Strings Array of phone numbers. Example value [+420737123456].

Previous article

Remove on-call schedule

Next article

List on-call schedule events