Skip to main content
API Explorer|API Explorer
Alerting & Response/On-Call
GETOnCallSince 1.0SynchronousAuth Required

GetOnCallCurrentShift

Get the currently active on-call shift for a given schedule

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the schedule whose current shift to retrieve

Responses

200 OK

On success, this API returns the following response structure.

  • userIdString

    User ID of the person currently on call

    Example: user-abc123

  • userNameString

    Display name of the person currently on call

    Example: Alice Smith

  • startTimeString

    Timestamp when the current shift started

    Example: 2026-01-15T08:00:00Z

  • endTimeString

    Timestamp when the current shift ends

    Example: 2026-01-15T08:00:00Z

  • isOverrideBoolean

    Whether this shift is the result of an override

    Example: false

Endpoint

GET/api/v1/oncall/schedules/{uuid}/current-shift

/api/v1/oncall/schedules/{uuid}/current-shift

Operation ID

GetOnCallCurrentShift

Permalink

Request Example

curl -X GET '{host}/api/v1/oncall/schedules/{uuid}/current-shift' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "userId": "user-abc123",
  "userName": "Alice Smith",
  "startTime": "example",
  "endTime": "example",
  "isOverride": false
}

Change History

This API has no change history records yet.

View all change history