Skip to main content
GET
/
on-call-schedules
/
{on_call_schedule_id}
Get on call schedule by ID
curl --request GET \
  --url https://api.opal.dev/v1/on-call-schedules/{on_call_schedule_id} \
  --header 'Authorization: Bearer <token>'
{
  "on_call_schedule_id": "50d5e9f6-f23f-4d5a-ae91-b2640cf3975e",
  "third_party_provider": "PAGER_DUTY",
  "remote_id": "P7OWH2R",
  "name": "Customer Support On-Call"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
on_call_schedule_id
string<uuid>
required

The ID of the on_call_schedule.

Response

200 - application/json

The requested on call schedule.

OnCallSchedule Object

Description

The OnCallSchedule object is used to represent an on call schedule.

Usage Example

Update a groups on call schedule from the UPDATE Groups endpoint.

​
on_call_schedule_id
string<uuid>

The ID of the on-call schedule.

Example:

"50d5e9f6-f23f-4d5a-ae91-b2640cf3975e"

​
third_party_provider
enum<string>

The third party provider of the on call schedule.

Available options:
OPSGENIE,
PAGER_DUTY
Example:

"PAGER_DUTY"

​
remote_id
string

The remote ID of the on call schedule

Example:

"P7OWH2R"

​
name
string

The name of the on call schedule.

Example:

"Customer Support On-Call"