---
title: "The catalogue of schedule presets"
method: GET
path: "/api/{org_id}/oncall/schedule-presets"
tags: ["OnCall"]
---

# The catalogue of schedule presets

`GET /api/{org_id}/oncall/schedule-presets`

## Request

- Base URL: `https://api.openobserve.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.openobserve.ai/api/{org_id}/oncall/schedule-presets`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/openobserve/apis/openobserve-api-http/docs/api/:org_id/oncall/schedule-presets/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `org_id` string, required

## Response `200`

Success

- PresetDescriptor[]
  - `description` string, required: One line: what applying it builds.
  - `id` 'follow_the_sun' | 'weekday_weekend' | 'split_the_week' | 'business_hours_plus_nights', required: Which preset. Serialises to the id the catalogue publishes.
  - `inputs` PresetInput[], required
    - `default` unknown
    - `description` string, required: One line of help.
    - `field` string, required: The JSON key, exactly as the request body spells it.
    - `fields` object[]: For `group` and `group_list`: the fields each group carries.
    - `kind` 'group' | 'group_list' | 'day_of_week' | 'day_list' | 'minute_of_day' | 'timezone' | 'duration_micros' | 'timestamp_micros' | 'text' | 'member_list', required: What kind of control a field is. Enough for a form to be generated rather than hardcoded — the UI should not have to know that `follow_the_sun` wants between two and four groups, because then it would have to be told twice.
    - `label` string, required: What to put beside the control.
    - `max` integer, nullable
    - `min` integer, nullable
    - `required` boolean, required
  - `layers` string[], required: The layers it generates, highest priority first, in the same words the generated schedule will use.
  - `name` string, required: What to call it on a button.

---

[API](https://skmtc.dev/openobserve/apis/openobserve-api-http.md) - [All operations](https://skmtc.dev/openobserve/apis/openobserve-api-http/llms.txt) - [OpenAPI document](https://skmtc.dev/openobserve/apis/openobserve-api-http/revisions/0529b8a10252?raw)