List shifts - Rootly

{ "data": [ { "id": "88bcc2a1-25d4-5acf-a43b-1535132072be", "type": "shifts", "attributes": { "schedule_id": "bb860693-900e-4443-98fe-f57e28b18127", "rotation_id": "28e10959-7a55-482c-98c3-b5dda669e6c3", "user_id": 577, "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": "577", "type": "users" } } } }, { "id": "37262bc9-3b26-56f0-9c5c-5e0c9320513e", "type": "shifts", "attributes": { "schedule_id": "bb860693-900e-4443-98fe-f57e28b18127", "rotation_id": "b7bae5d7-01f2-4789-b8d5-6d0edd79e59a", "user_id": 577, "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": "577", "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

Available options:

shift_override,

user

string

Start range for shifts

from

string

End range for shifts

user_ids[]

integer[]

schedule_ids[]

string[]

Response

success

data

object[]

required

Show child attributes

data.id

string

required

Unique ID of the shift

data.type

enum<string>

required

Available options:

shifts

data.attributes

object

required

Show child attributes

data.attributes.schedule_id

string

required

ID of schedule

data.attributes.rotation_id

string | null

required

ID of rotation

data.attributes.starts_at

string

required

Start datetime of shift

data.attributes.ends_at

string

required

End datetime of shift

data.attributes.is_override

boolean

required

Denotes shift is an override shift

data.attributes.shift_override

object

Override metadata

Show child attributes

data.attributes.shift_override.data

object

required

Show child attributes

data.attributes.shift_override.data.id

string

required

Unique ID of the shift override

data.attributes.shift_override.data.type

enum<string>

required

Available options:

shift_override

data.attributes.shift_override.data.attributes

object

required

Show child attributes

data.attributes.shift_override.data.attributes.shift_id

string

required

ID of shift

data.attributes.shift_override.data.attributes.created_by_user_id

integer

required

User who created the override

data.attributes.shift_override.data.attributes.created_at

string

Date of creation

data.attributes.shift_override.data.attributes.updated_at

string

Date of last update

data.attributes.user

object

User metadata

Show child attributes

data.attributes.user.data

object

required

Show child attributes

data.attributes.user.data.id

string

required

Unique ID of the user

data.attributes.user.data.type

enum<string>

required

Available options:

users

data.attributes.user.data.attributes

object

required

Show child attributes

data.attributes.user.data.attributes.email

string

required

The email of the user

data.attributes.user.data.attributes.created_at

string

required

Date of creation

data.attributes.user.data.attributes.updated_at

string

required

Date of last update

data.attributes.user.data.attributes.first_name

string | null

First name of the user

data.attributes.user.data.attributes.last_name

string | null

Last name of the user

data.attributes.user.data.attributes.full_name

string | null

The full name of the user

data.attributes.user.data.attributes.full_name_with_team

string | null

The full name with team of the user

data.attributes.user.data.attributes.time_zone

string | null

Configured time zone

data.attributes.user.data.relationships

object

Show child attributes

data.attributes.user.data.relationships.role

object

Show child attributes

data.attributes.user.data.relationships.role.data

object

Show child attributes

data.attributes.user.data.relationships.role.data.id

string

data.attributes.user.data.relationships.role.data.type

enum<string>

Available options:

roles

data.attributes.user.data.relationships.on_call_role

object

Show child attributes

data.attributes.user.data.relationships.on_call_role.data

object

Show child attributes

data.attributes.user.data.relationships.on_call_role.data.id

string

data.attributes.user.data.relationships.on_call_role.data.type

enum<string>

Available options:

on_call_roles

Overview

AlertEvents

AlertFields

AlertGroups

AlertRoutes

AlertRoutingRules

AlertUrgencies

AlertSources

Alerts

Audits

Authorizations

CatalogEntities

CatalogEntityProperties

CatalogFields

Catalogs

Causes

Communications Groups

Communications Stages

Communications Templates

Communications Types

[DEPRECATED] CustomFieldOptions

[DEPRECATED] CustomFields

CustomForms

DashboardPanels

Dashboards

Environments

EscalationPolicies

EscalationLevelsPolicies

EscalationLevelsPath

EscalationLevels

EscalationPaths

FormFieldOptions

FormFieldPlacementConditions

FormFieldPlacements

FormFieldPositions

FormFields

FormSetConditions

FormSets

Functionalities

WorkflowTasks

[DEPRECATED] WorkflowCustomFieldSelections

WorkflowFormFieldConditions

WorkflowGroups

WorkflowRuns

Workflows

Heartbeats

IncidentActionItems

[DEPRECATED] IncidentCustomFieldSelections

IncidentEventFunctionalities

IncidentEventServices

IncidentEvents

IncidentFeedbacks

IncidentFormFieldSelections

IncidentPermissionSetBooleans

IncidentPermissionSetResources

IncidentPermissionSets

IncidentRetrospectives

IncidentRetrospectiveSteps

IncidentRoleTasks

IncidentRoles

IncidentStatusPageEvents

IncidentSubStatuses

IncidentTypes

Incidents

IpRanges

LiveCallRouters

OnCallRoles

OnCallShadows

OverrideShifts

PlaybookTasks

Playbooks

RetrospectiveTemplates

Pulses

RetrospectiveConfigurations

RetrospectiveProcessGroupSteps

RetrospectiveProcessGroups

RetrospectiveProcesses

RetrospectiveSteps

Roles

ScheduleRotationActiveDays