Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced guide
  5. Incidents
    1. Get started
    2. Advanced guide
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
    4. Migrating to pay as you go
  9. Uptime API
    1. Get 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

Get on-call schedule

Returns a single on-call schedule by ID.

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

URL parameters

schedule_id
required string

The ID of the on-call schedule you want to get. Use default if you want to get the default on-call schedule 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 $TOKEN

200

Returns a single on-call schedule

Response body

{
  "data": {
    "id": "12345",
    "type": "on_call_calendar",
    "attributes": {
      "name": null,
      "default_calendar": true,
      "team_name": "Production"
    },
    "relationships": {
      "on_call_users": {
        "data": [
          {
            "id": "2345",
            "type": "user",
            "meta": {
              "email": "tomas@uptime.betterstack.com"
            }
          }
        ]
      }
    }
  },
  "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 $TOKEN"

Previous article

List on-call schedules

Next article

Create an on-call schedule