Get a rotation
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://api.roundrobinbot.eu/v1/rotations/example"), Headers = { { "Authorization", "Bearer <token>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}package main
import ( "fmt" "net/http" "io")
func main() {
url := "https://api.roundrobinbot.eu/v1/rotations/example"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder() .url("https://api.roundrobinbot.eu/v1/rotations/example") .get() .addHeader("Authorization", "Bearer <token>") .build();
Response response = client.newCall(request).execute();import axios from 'axios';
const options = { method: 'GET', url: 'https://api.roundrobinbot.eu/v1/rotations/example', headers: {Authorization: 'Bearer <token>'}};
try { const { data } = await axios.request(options); console.log(data);} catch (error) { console.error(error);}const url = 'https://api.roundrobinbot.eu/v1/rotations/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.roundrobinbot.eu/v1/rotations/example \ --header 'Authorization: Bearer <token>'One rotation, with its members, its lanes, its coverage windows and the hours each one covers, and its current on-call state embedded, so the common questions need no second call. Carries an ETag.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”OK
A rotation: the grid of duties it runs, who is in it, and who holds each place right now.
object
The short code the rotation answers to in Slack.
Whether every member of the workspace can see the rotation.
manual, auto or external.
How many lanes are running, which is how many people hold the shift at once.
How many places on this rotation have somebody on call right now.
How many places on this rotation have nobody on them at all.
Whether this rotation has more than one place to be on duty at once.
Whether one person may hold two places at once when the list behind them is too short to fill both.
Whether days the cadence skips — weekends, national holidays — count as time the rotation is not covered. One switch for the whole rotation, read into every window’s own reading.
The channels this rotation posts in: the same facts as channelSettings, flattened to the ids that receive duty messages.
Every channel this rotation uses, each saying what Round Robin does in it. Write one with PUT /v1/rotations/{rotationId}/channels/{channelId}.
One Slack channel a rotation uses, and what Round Robin does in it.
object
The Slack channel id, for example C0123456789.
Whether hand-overs, reminders and mentions of this rotation are posted in this channel.
Whether this channel’s topic is rewritten with whoever is on duty when duty changes hands. Reported as false on every channel when enableTopic is off, whatever the channel itself holds, so a reader never has to combine two fields to know whether a topic is written.
Whether the rotation keeps channel topics pointed at whoever is on duty. The switch for the whole rotation: with it off, no channel’s topic is written whatever its own syncsTopic says.
The template the topic is written from, or null to use Round Robin’s own wording. Shares its placeholders with the message templates, which are not part of this version.
Everybody in the rotation: the union across every list it draws on.
object
Members added individually.
One member of a rotation.
object
Where the member sits in the order the lists are built from.
Members that came in through a Slack user group, listed under the group they came from. Add or remove somebody in Slack’s group and the rotation follows.
A Slack user group in the rotation, and the people currently in it.
object
One member of a rotation.
object
Where the member sits in the order the lists are built from.
The rows of the grid: the kinds of duty this rotation runs.
A row of the grid: a kind of duty, such as primary or backend.
object
What the customer calls this lane, and absent until they name it.
The columns of the grid: covered hours, a time zone, and a handover cadence.
A column of the grid: when the rotation is covered, and how often duty changes hands there.
object
The one zone this window’s covered hours are expressed in, as its own identifier (Europe/Rome). Never rewritten to the tzdb canonical name a linked city shares. Empty on a manual rotation, which has no cadence and so no zone to express one in.
The repeating week this window is open for, as stored. Empty means the whole week.
One stretch of the coverage week, which may run past midnight into the next day.
object
A weekday name, monday through sunday.
A time of day, HH:mm.
Whether the window restricts nothing: open the whole week, every week.
How often duty changes hands in this column.
object
One of dayOfWeek, daysOfWeekList, dayOfMonth, nthWeekdayOfMonth, daily, workday, manual or external. Fields that mean nothing for the type are absent rather than defaulted, so test for presence rather than for a zero.
The time zone the cadence was configured with, as its own identifier (Europe/Rome). Never rewritten to the tzdb canonical name a linked city shares.
When the cadence starts, in its own time zone.
How many units of the cadence’s own kind sit between two hand-overs.
The countries whose weekends and holidays the skips are read from.
The next hand-overs this window has already scheduled. For anything further out, ask for a window from GET /v1/rotations/{rotationId}/schedule.
Set for dayOfWeek and nthWeekdayOfMonth.
Set for daysOfWeekList.
Set for dayOfMonth.
Set for nthWeekdayOfMonth: which occurrences in the month, 1 through 5.
Set for daily: the times of day it hands over at.
Set for external: which partner drives the rotation. One of pagerDuty, jsm for Jira Service Management, or none when the rotation is external but no partner is linked yet.
Whether the window is open at the moment of the response.
Every lane crossed with every window, and whoever holds each one.
A lane crossed with a window: one place somebody can be on duty.
object
Which list this place is dealt from, matching an entry in the rotation’s rosters.
Whether this place is defined but not running, because the workspace is not on a paid plan.
Whoever holds this place, or nothing.
object
The Slack user holding the place, or null when a partner named somebody Slack cannot.
Their position in the list this place is dealt from, and absent for a person a partner named, who was never dealt from a list at all.
Whether they are waiting for the window to open rather than on duty right now.
Members the list would otherwise have named, who were passed over because they were absent. A skip, decided once before the shift starts, rather than a hand-over of part of one.
A member skipped because of an absence at assignment time.
object
Slack user ID of the skipped member.
Absence start in UTC, when known.
Absence end in UTC, when known.
Absence source: googleCalendar or internalAvailability. Null when the source is unknown.
The lists this rotation deals from, each in the order this rotation deals it.
A list this rotation deals from, in the order this rotation deals it.
object
The list this order belongs to. Absent on a rotation whose people are not on a shared list yet.
The turn order: who is dealt, and in what order.
One position in a turn order.
object
Set when the member is in the order by way of a user group.
The turn the next handover deals from.
The Slack user group kept in sync with whoever is on call.
The on-call resource, embedded, so the common question needs no second call.
object
Current external assignment summary, including unmapped participants, empty slots and the next known boundary.
object
UTC instant used to evaluate current assignments and coverage.
Freshness: fresh, stale or unavailable. Fresh data covers asOfUtc, agrees with synchronized assignments and has no failed read at or after the last success.
Coverage: assigned when a user assignment is active; empty when only explicit empty assignments are active; gap for a confirmed interval with no assignments; otherwise unknown.
Time of the last successful provider read, or null when none is recorded.
Time of the last failed provider read, or null when none is recorded.
Inclusive start of the saved provider snapshot. Check state before using its coverage.
Exclusive end of the saved provider snapshot. Later coverage is unknown.
Synchronized assignments active at asOfUtc, including unmapped participants, duplicate assignments and explicit empty slots.
One external assignment interval, including an explicitly unassigned slot.
object
Stable local identity of a synchronized occurrence. Null for a future assignment without a synchronized identity.
Cell holding the synchronized assignment, or null for a future assignment without a stored cell.
Mapped Slack user ID. Null for unmapped participants and explicit empty slots.
Display label for an unmapped participant: provider name, email address or participant ID. Null for mapped users and empty slots.
Provider email address when available. Null for explicit empty slots or when no email is available.
Inclusive start of this assignment interval in UTC.
Exclusive end of this assignment interval in UTC.
Provider metadata for this assignment.
object
Assignment member kind: user or empty.
Provider participant ID for a user assignment. Null for an empty slot.
Provider source type: schedule_rotation, custom_shift, schedule_rotation_override or custom_shift_override.
Provider rotation ID for a rotation or rotation-override source.
Provider custom-shift ID for a custom-shift or custom-shift-override source.
Provider override ID for an override source.
Original provider start of the occurrence in UTC.
Provider end of the occurrence in UTC.
Number of current assignments, including explicit empty slots. This is an assignment count, not a staffing target.
Number of current user assignments, including unmapped participants and duplicate assignments.
Last provider read failure code, or null when none is recorded. Check state and the read timestamps for current freshness.
Distinct current responders, deduplicated by Slack user ID when mapped and provider participant ID otherwise.
Distinct provider participant IDs among current user assignments.
Current user assignments without a Slack mapping. Duplicate assignments count separately.
Current assignments that the provider explicitly leaves unassigned.
Next known boundary after asOfUtc, or null when none is known. Stale data supplies known ends only, without future starts.
object
UTC instant of the assignment boundary.
Assignments starting at atUtc, available only from a fresh provider snapshot.
One external assignment interval, including an explicitly unassigned slot.
object
Stable local identity of a synchronized occurrence. Null for a future assignment without a synchronized identity.
Cell holding the synchronized assignment, or null for a future assignment without a stored cell.
Mapped Slack user ID. Null for unmapped participants and explicit empty slots.
Display label for an unmapped participant: provider name, email address or participant ID. Null for mapped users and empty slots.
Provider email address when available. Null for explicit empty slots or when no email is available.
Inclusive start of this assignment interval in UTC.
Exclusive end of this assignment interval in UTC.
Provider metadata for this assignment.
object
Assignment member kind: user or empty.
Provider participant ID for a user assignment. Null for an empty slot.
Provider source type: schedule_rotation, custom_shift, schedule_rotation_override or custom_shift_override.
Provider rotation ID for a rotation or rotation-override source.
Provider custom-shift ID for a custom-shift or custom-shift-override source.
Provider override ID for an override source.
Original provider start of the occurrence in UTC.
Provider end of the occurrence in UTC.
Current assignments whose end is later than atUtc.
One external assignment interval, including an explicitly unassigned slot.
object
Stable local identity of a synchronized occurrence. Null for a future assignment without a synchronized identity.
Cell holding the synchronized assignment, or null for a future assignment without a stored cell.
Mapped Slack user ID. Null for unmapped participants and explicit empty slots.
Display label for an unmapped participant: provider name, email address or participant ID. Null for mapped users and empty slots.
Provider email address when available. Null for explicit empty slots or when no email is available.
Inclusive start of this assignment interval in UTC.
Exclusive end of this assignment interval in UTC.
Provider metadata for this assignment.
object
Assignment member kind: user or empty.
Provider participant ID for a user assignment. Null for an empty slot.
Provider source type: schedule_rotation, custom_shift, schedule_rotation_override or custom_shift_override.
Provider rotation ID for a rotation or rotation-override source.
Provider custom-shift ID for a custom-shift or custom-shift-override source.
Provider override ID for an override source.
Original provider start of the occurrence in UTC.
Provider end of the occurrence in UTC.
Current assignments ending at atUtc.
One external assignment interval, including an explicitly unassigned slot.
object
Stable local identity of a synchronized occurrence. Null for a future assignment without a synchronized identity.
Cell holding the synchronized assignment, or null for a future assignment without a stored cell.
Mapped Slack user ID. Null for unmapped participants and explicit empty slots.
Display label for an unmapped participant: provider name, email address or participant ID. Null for mapped users and empty slots.
Provider email address when available. Null for explicit empty slots or when no email is available.
Inclusive start of this assignment interval in UTC.
Exclusive end of this assignment interval in UTC.
Provider metadata for this assignment.
object
Assignment member kind: user or empty.
Provider participant ID for a user assignment. Null for an empty slot.
Provider source type: schedule_rotation, custom_shift, schedule_rotation_override or custom_shift_override.
Provider rotation ID for a rotation or rotation-override source.
Provider custom-shift ID for a custom-shift or custom-shift-override source.
Provider override ID for an override source.
Original provider start of the occurrence in UTC.
Provider end of the occurrence in UTC.
Rotation ID.
Current mapped Slack assignments. An empty list does not establish a coverage gap: check externalAssignments or unmappedExternalDuty.
One current mapped Slack assignment. A user can appear more than once when they hold multiple assignments.
object
Slack user ID of the person on duty.
Position in the native turn order. External assignments have no native turn order.
Cell holding this assignment.
Lane containing the cell. Lanes for external assignments do not identify provider roles.
Lane name, when available.
Window containing the cell. External assignment windows do not define provider recurrence.
Window name, when available.
Assignment start in UTC, when known.
Exclusive assignment end in UTC, when known.
Members skipped for absence when this assignment began.
A member skipped because of an absence at assignment time.
object
Slack user ID of the skipped member.
Absence start in UTC, when known.
Absence end in UTC, when known.
Absence source: googleCalendar or internalAvailability. Null when the source is unknown.
Single unmapped duty for an external schedule without externalAssignments. Null when externalAssignments is present.
object
Provider email address.
Provider display name, when available.
Exclusive assignment end in UTC, when known.
Directory records for current mapped Slack users and skipped members when ?expand=users is requested. Null otherwise. Expansion disables ETag validation.
A Slack user, as Round Robin knows them.
object
The Slack user id.
The workspace that owns this person’s directory entry, which under Enterprise Grid can differ from the calling key’s workspace.
Null when the install was never granted users:read.email, not only when unknown.
A Slack Connect person: visible through a shared channel, never a member of the workspace.
Deactivated in Slack, or gone from the workspace. These people are still answered rather than hidden, so an id a rotation still names resolves to something you can render.
The person’s Slack avatar, at 192px.
The person’s Slack time zone, as an IANA identifier (Europe/Rome). Absent when Round Robin has not seen one for them.
Examplegenerated
{ "id": "example", "name": "example", "description": "example", "code": "example", "enabled": true, "public": true, "mode": "example", "runningLanes": 1, "heldSeats": 1, "openSeats": 1, "isGrid": true, "doubleCover": true, "skipsAreOffTime": true, "owners": [ "example" ], "channels": [ "example" ], "channelSettings": [ { "channelId": "example", "postsMessages": true, "syncsTopic": true } ], "enableTopic": true, "topicTemplate": "example", "members": { "users": [ { "userId": "example", "sequenceNumber": 1 } ], "userGroups": [ { "userGroupId": "example", "users": [ { "userId": "example", "sequenceNumber": 1 } ] } ] }, "lanes": [ { "id": "example", "name": "example" } ], "windows": [ { "id": "example", "name": "example", "timeZone": "example", "coverage": [ { "startDay": "example", "startTime": "example", "endDay": "example", "endTime": "example" } ], "alwaysOpen": true, "cadence": { "type": "example", "timeZone": "example", "startsAt": "2026-04-15T12:00:00Z", "period": 1, "skipWeekends": true, "skipNationalHolidays": true, "countryCodes": [ "example" ], "nextEvents": [ "2026-04-15T12:00:00Z" ], "dayOfWeek": "example", "daysOfWeek": [ "example" ], "dayOfMonth": 1, "weeksInMonth": [ 1 ], "times": [ "example" ], "partner": "example" }, "openNow": true, "currentCoverage": { "startUtc": "2026-04-15T12:00:00Z", "endUtc": "2026-04-15T12:00:00Z" }, "nextCoverage": { "startUtc": "2026-04-15T12:00:00Z", "endUtc": "2026-04-15T12:00:00Z" } } ], "cells": [ { "id": "example", "laneId": "example", "windowId": "example", "rosterId": "example", "stopped": true, "holder": { "userId": "example", "externalUser": { "email": "example", "name": "example" }, "turn": 1, "waiting": true, "since": "2026-04-15T12:00:00Z", "until": "2026-04-15T12:00:00Z", "skippedForAbsence": [ { "userId": "example", "from": "2026-04-15T12:00:00Z", "until": "2026-04-15T12:00:00Z", "source": "example" } ] } } ], "rosters": [ { "rosterId": "example", "order": [ { "userId": "example", "userGroupId": "example", "turn": 1 } ], "nextTurn": 1 } ], "onDutyUserGroupId": "example", "onCall": { "externalAssignments": { "asOfUtc": "2026-04-15T12:00:00Z", "state": "example", "coverage": "example", "lastSuccessfulReadUtc": "2026-04-15T12:00:00Z", "lastReadFailureUtc": "2026-04-15T12:00:00Z", "knownFromUtc": "2026-04-15T12:00:00Z", "knownUntilUtc": "2026-04-15T12:00:00Z", "current": [ { "localAssignmentId": "example", "cellId": "example", "user": "example", "externalName": "example", "externalEmail": "example", "sinceUtc": "2026-04-15T12:00:00Z", "untilUtc": "2026-04-15T12:00:00Z", "externalAssignment": { "memberKind": "example", "participantId": "example", "sourceType": "example", "rotationId": "example", "shiftId": "example", "overrideId": "example", "originalStartUtc": "2026-04-15T12:00:00Z", "originalEndUtc": "2026-04-15T12:00:00Z" } } ], "requiredAssignmentCount": 1, "assignedAssignmentCount": 1, "lastReadFailure": "example", "distinctResponderCount": 1, "distinctParticipantCount": 1, "unmappedAssignmentCount": 1, "emptyAssignmentCount": 1, "nextChange": { "atUtc": "2026-04-15T12:00:00Z", "starting": [ { "localAssignmentId": "example", "cellId": "example", "user": "example", "externalName": "example", "externalEmail": "example", "sinceUtc": "2026-04-15T12:00:00Z", "untilUtc": "2026-04-15T12:00:00Z", "externalAssignment": { "memberKind": "example", "participantId": "example", "sourceType": "example", "rotationId": "example", "shiftId": "example", "overrideId": "example", "originalStartUtc": "2026-04-15T12:00:00Z", "originalEndUtc": "2026-04-15T12:00:00Z" } } ], "continuing": [ { "localAssignmentId": "example", "cellId": "example", "user": "example", "externalName": "example", "externalEmail": "example", "sinceUtc": "2026-04-15T12:00:00Z", "untilUtc": "2026-04-15T12:00:00Z", "externalAssignment": { "memberKind": "example", "participantId": "example", "sourceType": "example", "rotationId": "example", "shiftId": "example", "overrideId": "example", "originalStartUtc": "2026-04-15T12:00:00Z", "originalEndUtc": "2026-04-15T12:00:00Z" } } ], "ending": [ { "localAssignmentId": "example", "cellId": "example", "user": "example", "externalName": "example", "externalEmail": "example", "sinceUtc": "2026-04-15T12:00:00Z", "untilUtc": "2026-04-15T12:00:00Z", "externalAssignment": { "memberKind": "example", "participantId": "example", "sourceType": "example", "rotationId": "example", "shiftId": "example", "overrideId": "example", "originalStartUtc": "2026-04-15T12:00:00Z", "originalEndUtc": "2026-04-15T12:00:00Z" } } ] } }, "rotationId": "example", "onCall": [ { "userId": "example", "turn": 1, "cellId": "example", "laneId": "example", "laneName": "example", "windowId": "example", "windowName": "example", "since": "2026-04-15T12:00:00Z", "until": "2026-04-15T12:00:00Z", "skippedForAbsence": [ { "userId": "example", "from": "2026-04-15T12:00:00Z", "until": "2026-04-15T12:00:00Z", "source": "example" } ] } ], "unmappedExternalDuty": { "email": "example", "name": "example", "until": "2026-04-15T12:00:00Z" }, "users": [ { "id": "example", "teamId": "example", "displayName": "example", "realName": "example", "email": "example", "isGuest": true, "isExternal": true, "isDeleted": true, "avatarUrl": "example", "timeZone": "example" } ] }, "createdAt": "2026-04-15T12:00:00Z", "updatedAt": "2026-04-15T12:00:00Z"}Bad Request
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Unauthorized
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}