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

Get a single on-call calendar

Returns a single on-call calendar by ID.

GET https://uptime.betterstack.com/api/v2/on-calls/{calendar_id}

URL parameters

calendar_id
required string

The ID of the on-call calendar you want to get. Use default if you want to get the default on-call calendar for the team.

Query parameters

date
String

Include an ISO-8601-formatted date or date-time if you want to look-up on-call at a specific date or time.

Headers

Authorization
required string

Bearer $TEAM_TOKEN

200

Returns a single on-call calendar

Response body

{
  "data": {
    "id": "12345",
    "type": "on_call_calendar",
    "attributes": {
      "name": null,
      "default_calendar": true
    },
    "relationships": {
      "on_call_users": {
        "data": [
          {
            "id": "2345",
            "type": "user"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "2345",
      "type": "user",
      "attributes": {
        "first_name": "Tomas",
        "last_name": "Hromada",
        "email": "tomas@uptime.betterstack.com",
        "phone_numbers": [
          "+420737123456"
        ]
      }
    }
  ]
}

Example cURL

Example
curl --request GET \
  --url "https://uptime.betterstack.com/api/v2/on-calls/default" \
  --header "Authorization: Bearer $TEAM_TOKEN"

Previous article

List all existing on-call calendars

Next article

On-call calendar API response params