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. Pagination
    3. Monitors
    4. Heartbeats
    5. 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
      3. On-call schedule rotations
      4. Escalation policies
      5. Escalation policy groups
      6. Severities
      7. Severity groups
      8. Incidents
      9. Comments
    6. Status pages
    7. Metadata
    8. Integrations
    9. Team members
    10. Organization roles
    11. Usage
    12. Reporting

Get a single on-call schedule event

Get a single event from an on-call schedule.

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

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.

event_id
required string

The ID of the event to return.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns the requested event.

Response body

{
  "id": 12345,
  "users": [
    "tomas@betterstack.com"
  ],
  "starts_at": "2024-09-04T22:00:00Z",
  "ends_at": "2024-09-05T22:00:00Z",
  "override": false
}

Response attributes

id
integer

The ID of the event.

users
array

The e-mails of the people on call during the event.

starts_at
string

When the event starts, as an ISO 8601 date-time in UTC.

ends_at
string

When the event ends, as an ISO 8601 date-time in UTC.

override
boolean

Whether the event is an override. Override events take precedence over regular scheduled events.

Example cURL

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


Previous article

List on-call schedule events

Next article

Create an on-call schedule event