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>",
      "type": "shifts",
      "attributes": {
        "schedule_id": "<string>",
        "rotation_id": "<string>",
        "starts_at": "<string>",
        "ends_at": "<string>",
        "is_override": true,
        "shift_override": {
          "data": {
            "id": "<string>",
            "type": "shift_override",
            "attributes": {
              "shift_id": "<string>",
              "created_by_user_id": 123,
              "created_at": "<string>",
              "updated_at": "<string>"
            }
          }
        },
        "user": {
          "data": {
            "id": "<string>",
            "type": "users",
            "attributes": {
              "email": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "first_name": "<string>",
              "last_name": "<string>",
              "full_name": "<string>",
              "full_name_with_team": "<string>",
              "time_zone": "<string>"
            },
            "relationships": {
              "role": {
                "data": {
                  "id": "<string>",
                  "type": "roles"
                }
              },
              "on_call_role": {
                "data": {
                  "id": "<string>",
                  "type": "on_call_roles"
                }
              }
            }
          }
        }
      }
    }
  ]
}

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
to
string

Start range for shifts

from
string

End range for shifts

user_ids[]
integer[]
schedule_ids[]
string[]

Response

success

data
object[]
required