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": "c4fd3434-e216-48a2-b24e-73168a5b3163",
      "type": "shifts",
      "attributes": {
        "schedule_id": "bf4ef982-41a6-4705-8121-5201fa9dbe40",
        "rotation_id": "8463848a-8c66-4131-825f-6882953f84cc",
        "user_id": 1032,
        "starts_at": "2024-07-02T21:00:00.000-07:00",
        "ends_at": "2024-07-02T23:00:00.000-07:00",
        "is_override": true
      },
      "relationships": {
        "shift_override": {
          "data": null
        },
        "user": {
          "data": {
            "id": "1032",
            "type": "users"
          }
        }
      }
    },
    {
      "id": "60872e9d-f3dc-54ef-8ea0-945b7c05e363",
      "type": "shifts",
      "attributes": {
        "schedule_id": "bf4ef982-41a6-4705-8121-5201fa9dbe40",
        "rotation_id": "68be1d1b-98e1-43d3-8ea1-b01aba1dcbd5",
        "user_id": 1032,
        "starts_at": "2024-07-02T19:00:00.000-07:00",
        "ends_at": "2024-07-02T21:00:00.000-07:00",
        "is_override": false
      },
      "relationships": {
        "shift_override": {
          "data": null
        },
        "user": {
          "data": {
            "id": "1032",
            "type": "users"
          }
        }
      }
    }
  ]
}

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
​
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[]

Response

success

​
data
object[]
required