List shifts

List shifts

GET /v1/shifts

List shifts

cURL

curl --request GET \
  --url https://api.rootly.com/v1/shifts \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "<string>",
      "type": "shifts",
      "attributes": {
        "schedule_id": "<string>",
        "rotation_id": "<string>",
        "starts_at": "<string>",
        "ends_at": "<string>",
        "is_override": true,
        "user_id": 123
      },
      "relationships": {
        "shift_override": {
          "data": {
            "id": "<string>",
            "type": "shift_overrides"
          }
        },
        "user": {
          "data": {
            "id": "<string>",
            "type": "users"
          }
        },
        "assignee": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

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

200

application/vnd.api+json

success

data · object[] · required

Show child attributes