Docs

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

Sign in Start free

Get on-call coverage

Returns the schedule ID, current on-call member, scheduled members, and echoed from and to values.

GET https://app.upfour.io/v1/oncall-schedules/{scheduleID}/coverage
GET https://app.upfour.io/v1/oncall-schedules/{scheduleID}/coverage
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 OnCallCoverageResponse
OnCallCoverageResponse · 21 fields
FieldTypeDescription
current_on_call OnCallMember · nullable The person on call right now, an active override first; null 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
from string · nullable The from query parameter as sent, null when omitted. It does not filter anything.
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
schedule_id uuid
to string · nullable The to query parameter as sent, null when omitted. It does not filter anything.

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.