List duty arrangements

GET

/v1/rotations/{rotationId}/duty-arrangements

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/duty-arrangements?from=2026-04-15T12%3A00%3A00Z&to=2026-04-15T12%3A00%3A00Z"),
    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/duty-arrangements?from=2026-04-15T12%3A00%3A00Z&to=2026-04-15T12%3A00%3A00Z"

  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/duty-arrangements?from=2026-04-15T12%3A00%3A00Z&to=2026-04-15T12%3A00%3A00Z")
  .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/duty-arrangements',
  params: {from: '2026-04-15T12:00:00Z', to: '2026-04-15T12:00:00Z'},
  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/duty-arrangements?from=2026-04-15T12%3A00%3A00Z&to=2026-04-15T12%3A00%3A00Z';
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/duty-arrangements?from=2026-04-15T12%3A00%3A00Z&to=2026-04-15T12%3A00%3A00Z' \
  --header 'Authorization: Bearer <token>'

Requires read:oncall. Returns active arrangements overlapping a UTC range of at most 90 days. Cancelled arrangements are excluded. The response ETag identifies the rotation version for a later write. A range with missing bounds, a nonzero UTC offset or an end at or before its start returns 422 with invalidArrangementRange.

Authorizations

ApiKey

Parameters

Path Parameters

rotationId

required

string

The rotation identifier.

Query Parameters

from

required

string format: date-time

The inclusive range start with UTC offset zero.

required

string format: date-time

The exclusive range end with UTC offset zero, at most 90 days after from.

Responses

200

application/json

Active arrangements overlapping the requested range, with current cell capabilities.

object

asOfUtc

required

The instant every phase and capability in the response was evaluated.

string format: date-time

capabilities

required

Direct-assignment capability for each rotation cell.

Array<object>

Current direct-assignment capability for a rotation cell.

object

actionable

required

Whether to offer the assignment now: canAssign and no existingCommitment.

boolean

actionableReason

required

Why actionable is false: the reasonCode when canAssign is false, otherwise existingCommitment (an accepted cover or a swap leg holds the cell now). Null exactly when actionable is true.

null | string

canAssign

required

Whether the caller can submit a direct assignment, subject to term and conflict validation.

boolean

cellId

required

The rotation cell identifier.

string

eligibleUserIds

required

Slack user identifiers of current lane members, excluding known deactivated users and bots. An unknown profile does not remove lane membership.

Array<string>

reason

required

A refusal code when assignment is unavailable; otherwise null.

null | string

reasonCode

required

The same word as reason: why canAssign is false, null while it is true.

null | string

complete

required

Whether the full matching arrangement list was returned.

boolean

from

required

The requested inclusive UTC start.

string format: date-time

items

required

Matching arrangements ordered by start and identifier. Cancelled arrangements are excluded.

Array<object>

An interval assignment. Its recorded terms remain distinct from actual served history.

object

cellId

required

The rotation cell identifier.

string

changesAtUtc

required

The next instant at which phase changes, or null once it has ended.

null | string format: date-time

from

required

The inclusive UTC start.

string format: date-time

required

The arrangement identifier.

string

kind

required

directAssignment, acceptedCover or swapLeg. Direct-assignment writes change or end only directAssignment.

string

origin

One of:

null
object

null

originalSnapshot

One of:

null
object

null

Original duty segments on detail reads. Null on list reads or when no original record is available.

object

asOfUtc

required

The UTC time when the original duty was evaluated.

string format: date-time

complete

required

Whether every returned segment is resolved. An extension beyond the original recorded interval is unresolved.

boolean

from

required

The inclusive UTC start of the returned interval.

string format: date-time

segments

required

Original holders by interval, including periods with no assignee and unresolved periods.

Array<object>

Effective duty during part of an assignment interval.

object

from

required

The inclusive UTC start.

string format: date-time

resolved

required

Whether the holders or absence of duty are known for this interval.

boolean

required

The exclusive UTC end.

string format: date-time

userIds

required

Slack user identifiers of the effective holders. An empty list means no assignee only when resolved is true.

Array<string>

required

The exclusive UTC end of the returned interval.

string format: date-time

phase

required

upcoming, running or ended, from from and to at the time the response is built.

string

revision

required

The arrangement revision used when changing or ending it.

integer format: int64

rotationId

required

The rotation identifier.

string

state

required

active or cancelled. An active record can describe an interval that has already ended.

string

required

The exclusive UTC end.

string format: date-time

turnSelection

One of:

null
object

null

The recorded full or remaining turn, or null when no verified selection was saved. Use the arrangement’s From and To for the affected interval.

object

from

required

The inclusive UTC start of the original turn, including any part already served.

string format: date-time

kind

required

fullTurn or remainingTurn.

string

required

The exclusive UTC end of the original turn.

string format: date-time

userId

required

The assigned person’s Slack user identifier.

string

required

The requested exclusive UTC end.

string format: date-time

Example^generated

{
  "asOfUtc": "2026-04-15T12:00:00Z",
  "capabilities": [
    {
      "actionable": true,
      "actionableReason": "example",
      "canAssign": true,
      "cellId": "example",
      "eligibleUserIds": [
        "example"
      ],
      "reason": "example",
      "reasonCode": "example"
    }
  ],
  "complete": true,
  "from": "2026-04-15T12:00:00Z",
  "items": [
    {
      "cellId": "example",
      "changesAtUtc": "2026-04-15T12:00:00Z",
      "from": "2026-04-15T12:00:00Z",
      "id": "example",
      "kind": "example",
      "origin": {
        "complete": true,
        "userIds": [
          "example"
        ]
      },
      "originalSnapshot": {
        "asOfUtc": "2026-04-15T12:00:00Z",
        "complete": true,
        "from": "2026-04-15T12:00:00Z",
        "segments": [
          {
            "from": "2026-04-15T12:00:00Z",
            "resolved": true,
            "to": "2026-04-15T12:00:00Z",
            "userIds": [
              "example"
            ]
          }
        ],
        "to": "2026-04-15T12:00:00Z"
      },
      "phase": "example",
      "revision": 1,
      "rotationId": "example",
      "state": "example",
      "to": "2026-04-15T12:00:00Z",
      "turnSelection": {
        "from": "2026-04-15T12:00:00Z",
        "kind": "example",
        "to": "2026-04-15T12:00:00Z"
      },
      "userId": "example"
    }
  ],
  "to": "2026-04-15T12:00:00Z"
}

List duty arrangements

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Examplegenerated

Example^generated