Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Get an on-call rotation

Returns the rotation's members, handoff settings, time zone, current on-call person, and client scope.

GET https://app.upfour.io/v1/oncall-schedules/{scheduleID}
GET https://app.upfour.io/v1/oncall-schedules/{scheduleID}
Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs oncall.read.
Path

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope oncall.read stable returns 200

Parameters

FieldTypeDescription
scheduleID required uuid path parameter

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data OnCallSchedule
OnCallSchedule · 28 fields
FieldTypeDescription
created_at string (date-time)
handoff_day integer Weekday of the weekly handoff, 0 = Sunday to 6 = Saturday.
handoff_time string HH:MM:SS in the schedule's time zone.
id uuid
members OnCallMember[] · nullable
Each item · 8 fields
FieldTypeDescription
created_at string (date-time)
id uuid
schedule_id uuid
sort_order integer
user_id uuid
email string
first_name string
last_name string
name string
organization_id uuid
rotation_type string one ofdailyweeklycustom
timezone string
updated_at string (date-time)
client_id uuid
current_oncall OnCallMember The person on call right now, an active override first; absent while nobody is.
OnCallMember · 8 fields
FieldTypeDescription
created_at string (date-time)
id uuid
schedule_id uuid
sort_order integer
user_id uuid
email string
first_name string
last_name string

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
404 not_found The requested resource does not exist or is outside the caller's scope.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.