Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started with monitoring
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started with on-call
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced on-call setup
  5. Incidents
    1. Working with incidents
    2. Create incidents manually
    3. Post mortems
    4. Incident silencing
    5. Incident metadata
  6. Status pages
    1. Get started with status pages
    2. Working with status pages
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
  9. API
    1. Get started with API
  10. Monitors API
    1. Monitors
    2. Monitor groups
    3. Heartbeats
    4. Heartbeat groups
  11. On-call & Incidents API
    1. On-call calendar
      1. List all existing on-call calendars GET
      2. Get a single on-call calendar GET
      3. On-call calendar API response params
    2. Escalation policies
    3. Severities
    4. Incidents
    5. Comments
  12. Integrations API
    1. New Relic Integrations
    2. Datadog Integrations
    3. AWS CloudWatch Integrations
    4. Azure Integrations
    5. Google Monitoring Integrations
    6. Grafana Integrations
    7. Prometheus Integrations
    8. Email integrations
    9. Incoming webhooks
    10. Splunk On-Call integrations
    11. PagerDuty Integrations
  13. Status pages API
    1. Status pages
    2. Status page sections
    3. Status page resources
    4. Status page reports
    5. Status page report updates
  14. Other API
    1. Metadata

On-call calendar API response params

Response body parameters

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 calendar
type String on_call_calendar
attributes Object Attributes object (see below)
attributes.name String Name of the on-call calendar
attributes.default_calendar Boolean Is the on-call calendar default on-call calendar?
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

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.first_name String Last name of the on-call user
attributes.email String Email of the on-call user
attributes.phone_numbers Array of Strings Array of phone numbers. Example value [+420737123456]

Previous article

Get a single on-call calendar

Next article

List all escalation policies