List on-calls

List who is currently on-call, with support for filtering by escalation policy, schedule, and user. Returns on-call entries grouped by escalation policy level.

GET /v1/oncalls

List on-calls

cURL

curl --request GET \
  --url https://api.rootly.com/v1/oncalls \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.rootly.com/v1/oncalls"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rootly.com/v1/oncalls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootly.com/v1/oncalls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/oncalls"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.rootly.com/v1/oncalls")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/oncalls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "id": "<string>",
      "type": "on_call_resources",
      "attributes": {
        "escalation_policy_id": "<string>",
        "escalation_policy_name": "<string>",
        "user_id": 123,
        "starts_at": "2023-11-07T05:31:56Z",
        "ends_at": "2023-11-07T05:31:56Z",
        "escalation_policy_path_id": "<string>",
        "escalation_policy_path_name": "<string>",
        "is_default_path": true,
        "escalation_level": 123,
        "schedule_id": "<string>",
        "schedule_name": "<string>"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "<string>",
            "type": "users"
          }
        },
        "schedule": {
          "data": {
            "id": "<string>",
            "type": "schedules"
          }
        },
        "escalation_policy": {
          "data": {
            "id": "<string>",
            "type": "escalation_policies"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

include · enum<string>

comma separated if needed. eg: user,schedule

Available options: user, schedule, escalation_policy

since · string

Start of time range in ISO-8601 format (e.g., 2025-01-01T00:00:00Z). Defaults to current time.

until · string

End of time range in ISO-8601 format (e.g., 2025-01-01T00:00:00Z). Defaults to 'since' time.

earliest · boolean

When true, returns only the first on-call entry per escalation policy path and level

time_zone · string

Timezone for response times (e.g., America/New_York). Defaults to UTC.

filter[escalation_policy_ids] · string

Comma-separated escalation policy IDs

filter[schedule_ids] · string

Comma-separated schedule IDs

filter[user_ids] · string

Comma-separated user IDs

filter[service_ids] · string

Comma-separated service IDs

filter[group_ids] · string

Comma-separated group IDs (teams)

filter[notification_types] · string

Comma-separated notification types to include. One or both of: audible, quiet. When omitted, returns oncalls from all non-deferral escalation paths. When provided, limits results to matching notification types and sorts audible-first.

Response

200

application/vnd.api+json

success

data · object[] · required

Show child attributes

included · object[]

Show child attributes