Skip to main content
GET
/
v1
/
shifts
List shifts
curl --request GET \
  --url https://api.rootly.com/v1/shifts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "attributes": {
        "schedule_id": "<string>",
        "rotation_id": "<string>",
        "starts_at": "<string>",
        "ends_at": "<string>",
        "is_override": true,
        "is_shadow": true,
        "user_id": 123
      },
      "relationships": {
        "shift_override": {
          "data": {
            "id": "<string>"
          }
        },
        "user": {
          "data": {
            "id": "<string>"
          }
        },
        "assignee": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        }
      }
    }
  ],
  "meta": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123,
    "next_cursor": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.rootly.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
include
enum<string>

comma separated if needed. eg: shift_override,user. Note: user is deprecated, use assignee instead.

Available options:
shift_override,
user,
assignee,
shift_shadow
​
from
string

Start range for shifts in ISO-8601 format (e.g., 2025-01-01T00:00:00Z or 2025-01-01T00:00:00+00:00)

​
to
string

End range for shifts in ISO-8601 format (e.g., 2025-01-01T00:00:00Z or 2025-01-01T00:00:00+00:00)

​
user_ids[]
integer[]
​
schedule_ids[]
string[]
​
page[number]
integer

Page number (defaults to 1)

​
page[size]
integer

Number of shifts per page (defaults to 50, max 1000)

Response

success

​
data
object[]
required
​
meta
object