Skip to content

Get a cover request

GET
/v1/rotations/{rotationId}/cover-requests/{requestId}
curl --request GET \
--url https://api.roundrobinbot.eu/v1/rotations/example/cover-requests/example \
--header 'Authorization: Bearer <token>'

Requires read:oncall and a key whose workspace and rotation selector permit this rotation. Returns the request, read-only action capabilities and rotation ETag. Closed requests remain readable. An inaccessible request returns 404.

rotationId
required
string
requestId
required
string

OK

Media typeapplication/json

A permitted cover request, its rotation name and caller-specific capabilities.

object
actionable
required

True when the caller may accept, decline, cancel or end the request.

boolean
active
required

True while the request is pending or accepted.

boolean
asOfUtc
required

The instant the state, phase and capabilities were evaluated.

string format: date-time
capability
required

The actions available to the caller.

object
canAccept
required

Whether the caller may accept the request.

boolean
canCancel
required

Whether the caller may cancel the request.

boolean
canDecline
required

Whether the caller may decline the request.

boolean
canEnd
required

Whether the caller may end the accepted cover.

boolean
reason
required

The reason the actions are unavailable. Absent when they are available.

null | string
reasonCode
required

The same word as reason, or null when the actions are available.

null | string
changesAtUtc
required

The earliest later instant at which the state, phase, active or actionable changes by the clock alone. Null when none will.

null | string format: date-time
request
required

The request.

object
acceptedUserId
required

The user who accepted. Absent until accepted.

null | string
arrangementId
required

The assignment identifier created by acceptance. Absent until accepted.

null | string
cellId
required

The cell identifier.

string
declinedUserIds
required

The recipients who declined.

Array<string>
from
required

The inclusive interval start.

string format: date-time
id
required

The request identifier.

string
phase
required

upcoming, running or ended for the requested interval at the instant the response is built.

string
reason
required

The reason given with the request.

string
recipientUserIds
required

The users asked to cover.

Array<string>
requesterUserId
required

The user who made the request.

string
revision
required

The revision of the request.

integer format: int64
rotationId
required

The rotation identifier.

string
state
required

The lifecycle state of the request.

string
to
required

The exclusive interval end.

string format: date-time
rotationName
required

The name of the rotation.

string
Examplegenerated
{
"actionable": true,
"active": true,
"asOfUtc": "2026-04-15T12:00:00Z",
"capability": {
"canAccept": true,
"canCancel": true,
"canDecline": true,
"canEnd": true,
"reason": "example",
"reasonCode": "example"
},
"changesAtUtc": "2026-04-15T12:00:00Z",
"request": {
"acceptedUserId": "example",
"arrangementId": "example",
"cellId": "example",
"declinedUserIds": [
"example"
],
"from": "2026-04-15T12:00:00Z",
"id": "example",
"phase": "example",
"reason": "example",
"recipientUserIds": [
"example"
],
"requesterUserId": "example",
"revision": 1,
"rotationId": "example",
"state": "example",
"to": "2026-04-15T12:00:00Z"
},
"rotationName": "example"
}