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
    9. Organization roles
    10. Usage
    11. Reporting

List on-call schedule events

List events of a single on-call schedule. This endpoint does not support pagination and returns all events instead.

Filter by time range with the optional starts_at and ends_at query parameters. Only events that fall entirely within the window are returned.

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

URL parameters

schedule_id
required string

The ID of the on-call schedule you want to get events for. Use default to refer to the default on-call schedule for the team.

Query parameters

starts_at
string

Return only events that start at or after this time. ISO 8601 date-time, for example 2024-09-04T22:00:00Z.

ends_at
string

Return only events that end at or before this time. ISO 8601 date-time, for example 2024-09-05T22:00:00Z.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns a list of events for the given on-call schedule.

Response body

{
  "events": [
    {
      "id": 12345,
      "users": [
        "tomas@betterstack.com"
      ],
      "starts_at": "2024-09-04T22:00:00Z",
      "ends_at": "2024-09-05T22:00:00Z",
      "override": false
    },
    {
      "id": 23456,
      "users": [
        "simon@betterstack.com"
      ],
      "starts_at": "2024-09-05T22:00:00Z",
      "ends_at": "2024-09-06T22:00:00Z",
      "override": false
    },
    {
      "id": 34567,
      "users": [
        "tomas@betterstack.com"
      ],
      "starts_at": "2024-09-06T22:00:00Z",
      "ends_at": "2024-09-07T22:00:00Z",
      "override": true
    }
  ]
}

Example cURL

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


Previous article

Response attributes

Next article

Get a single on-call schedule event