Shifts for Microsoft Teams
For managers, plan shift schedules, broadcast open and unfilled shifts to your team. For team members, easily view your shifts and make schedule-change requests (swap/offer/time off).
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure China regions |
Power Automate | Standard | All Power Automate regions except the following: - China Cloud operated by 21Vianet |
Power Apps | Standard | All Power Apps regions except the following: - China Cloud operated by 21Vianet |
Contact | |
---|---|
Name | Microsoft |
URL | https://support.microsoft.com/teams |
Connector Metadata | |
---|---|
Publisher | Microsoft |
Website | https://docs.microsoft.com/en-us/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page |
Privacy policy | https://privacy.microsoft.com/privacystatement |
Categories | Productivity |
Shifts in Microsoft Teams is a schedule management tool that helps you create, update, and manage schedules for your team.
Shifts + Power Automate lets you take info from Shifts and create custom workflows with other apps and perform operations at scale. Automate key processes with little to no code.
- Triggers are not supported in the GCC region.
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Approve a Swap Shifts request |
This operation allows a user to approve a Swap Shifts request. |
Approve a Time Off request |
This operation allows managers to approve a Time Off request. |
Approve an Offer Shift request |
This operation allows recipients/managers to approve an Offer Shift request. |
Approve an Open Shift request |
This operation allows managers to approve an Open Shift request. |
Create a new Open Shift |
Create a new Open Shift in a Schedule. |
Create a new Shift |
This operation creates a new Shift and assigns it to a member of the team |
Create a new Time Off instance |
This operation creates a new Time Off instance and assigns it to a member of the team |
Decline a Swap Shifts request |
This operation allows users to decline a Swap Shifts request. |
Decline a Time Off request |
This operation allows managers to decline a Time Off request. |
Decline an Offer Shift request |
This operation allows users to decline an Offer Shift request. |
Decline an Open Shift request |
This operation allows managers to decline an Open Shift request. |
Delete a Shift |
This operation deletes a Shift using the Shift's unique ID. |
Delete a Time Off instance |
This operation deletes a Time Off using its unique ID. |
Delete an Open Shift |
This operation deletes an Open Shift. |
Get a Schedule's details |
This operation returns details of a Schedule using the Schedule's unique ID. |
Get a Scheduling Group |
This operation returns details for a Scheduling Group using its unique ID. |
Get a Shift |
This operation returns details for a Shift using the Shift's unique ID. |
Get a Swap Shifts request |
This operation returns a Swap Shifts request by ID. |
Get a Time Off instance |
This operation returns details for a Time Off using its unique ID. |
Get a Time Off request |
This operation returns a Time Off request by ID. |
Get an Offer Shift request |
This operation returns an Offer Shift request by ID. |
Get an Open Shift |
This operation returns details for an Open Shift. |
Get an Open Shift request |
This operation returns an Open Shift change request by ID. |
List all Offer Shift requests in a team |
This operation returns all Offer Shift requests in a Schedule. |
List all Open Shift requests in a team |
This operation returns all Open Shift change requests in a Schedule. |
List all Open Shifts from my teams |
This operation returns Open Shifts that need to be filled from all your teams. |
List all Open Shifts in a team |
This operation returns all Open Shifts in a team. |
List all Scheduling Groups in a team |
This operation returns all Scheduling Groups in a Schedule. |
List all Shifts from my teams |
This operation returns assigned Shifts from all your teams. |
List all Shifts in a team |
This operation returns all Shifts assigned to members of a team |
List all Swap Shifts requests in a team |
This operation returns all Swap Shifts requests in a Schedule. |
List all Time Off instances in a team |
This operation returns all Time Off instances in a Schedule |
List all Time Off Reasons in a team |
This operation returns the list of Time Off Reasons associated with a team. |
List all Time Off requests in a team |
This operation returns all Time Off requests in a Schedule. |
List all Times Off from my teams |
This operation returns times when people are off from all your teams. |
Update an Open Shift |
Update an Open Shift in a Schedule. |
This operation allows a user to approve a Swap Shifts request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Swap Shifts Change Request ID
|
swapShiftsChangeRequestId | True | string |
The unique ID of the request |
Message From Recipient/Manager
|
message | string |
A message when a request is accepted. |
Returns
This operation allows managers to approve a Time Off request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Time Off Request ID
|
timeOffRequestId | True | string |
The unique ID of the Time Off request |
Message From Manager
|
message | string |
A message from the manager to the sender/recipient when a request is accepted. |
Returns
This operation allows recipients/managers to approve an Offer Shift request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Offer Shift Request ID
|
offerShiftRequestId | True | string |
The unique ID of the Offer Shift request |
Message From Recipient/Manager
|
message | string |
A message when a request is accepted. |
Returns
This operation allows managers to approve an Open Shift request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Open Shift Change Request ID
|
openShiftChangeRequestId | True | string |
The unique ID of the request |
Message From Manager
|
message | string |
A message from the manager to the sender/recipient when a request is accepted. |
Returns
Create a new Open Shift in a Schedule.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Scheduling Group ID
|
schedulingGroupId | string |
Scheduling Group ID |
|
Display Name
|
displayName | string |
Display Name |
|
Notes
|
notes | string |
Notes |
|
Start Time
|
startDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Theme
|
theme | string |
Theme color. |
|
Open Slot Count
|
openSlotCount | True | integer |
Open Slot Count |
Is Paid
|
isPaid | boolean |
Is Paid |
|
Start Time
|
startDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Code
|
code | string |
Code |
|
Display Name
|
displayName | string |
Display Name |
Returns
Open Shift Entity
- Open Shift
- OpenShiftResponse
This operation creates a new Shift and assigns it to a member of the team
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Scheduling Group ID
|
schedulingGroupId | string |
Scheduling Group ID |
|
Display Name
|
displayName | string |
Display Name |
|
Notes
|
notes | string |
Shift Notes |
|
Start Time
|
startDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Theme
|
theme | True | string |
Theme color. |
Is Paid
|
isPaid | boolean |
Is Paid |
|
Start Time
|
startDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Code
|
code | string |
Code |
|
Display Name
|
displayName | string |
Display Name |
|
User ID
|
userId | True | string |
Assigned to User ID |
Returns
Shift Entity.
- Shift
- ShiftResponse
This operation creates a new Time Off instance and assigns it to a member of the team
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Time Off Reason
|
timeOffReasonId | True | string |
Time Off Reason ID |
Start Time
|
startDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Theme
|
theme | True | string |
Theme color. |
User ID
|
userId | True | string |
Assigned to User ID |
Returns
Time Off Entity.
- Time Off
- TimeOffResponse
This operation allows users to decline a Swap Shifts request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Swap Shifts Change Request ID
|
swapShiftsChangeRequestId | True | string |
The unique ID of the request |
Message From Recipient/Manager
|
message | string |
A message when a request is declined. |
Returns
This operation allows managers to decline a Time Off request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Time Off Request ID
|
timeOffRequestId | True | string |
The unique ID of the Time Off request |
Message From Manager
|
message | string |
A message from the manager to the sender/recipient when a request is declined. |
Returns
This operation allows users to decline an Offer Shift request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Offer Shift Request ID
|
offerShiftRequestId | True | string |
The unique ID of the Offer Shift request |
Message From Recipient/Manager
|
message | string |
A message when a request is declined. |
Returns
This operation allows managers to decline an Open Shift request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Open Shift Change Request ID
|
openShiftChangeRequestId | True | string |
The unique ID of the request |
Message From Manager
|
message | string |
A message from the manager to the sender/recipient when a request is declined. |
Returns
This operation deletes a Shift using the Shift's unique ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Shift ID
|
shiftId | True | string |
The unique ID of the Shift. |
This operation deletes a Time Off using its unique ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Time Off ID
|
timeOffId | True | string |
The unique ID of the Time Off. |
This operation deletes an Open Shift.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Open Shift ID
|
openShiftId | True | string |
The unique ID of the Open Shift. |
This operation returns details of a Schedule using the Schedule's unique ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Returns
Schedule Entity.
- Body
- ScheduleResponse
This operation returns details for a Scheduling Group using its unique ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Scheduling Group ID
|
schedulingGroupId | True | string |
The unique ID of the Scheduling Group. |
Returns
Scheduling Group Entity
- Scheduling Group
- SchedulingGroupResponse
This operation returns details for a Shift using the Shift's unique ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Shift ID
|
shiftId | True | string |
The unique ID of the Shift. |
Returns
Shift Entity.
- Shift
- ShiftResponse
This operation returns a Swap Shifts request by ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Swap Shifts Change Request ID
|
swapShiftsChangeRequestId | True | string |
The unique ID of the request |
Returns
Swap Shift Request Entity
- Swap Shift Request
- SwapShiftsChangeRequestResponse
This operation returns details for a Time Off using its unique ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Time Off ID
|
timeOffId | True | string |
The unique ID of the Time Off. |
Returns
Time Off Entity.
- Time Off
- TimeOffResponse
This operation returns a Time Off request by ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Time Off Request ID
|
timeOffRequestId | True | string |
The unique ID of the Time Off request |
Returns
Time Off Request Entity
- Time Off Request
- TimeOffRequestResponse
This operation returns an Offer Shift request by ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Offer Shift Request ID
|
offerShiftRequestId | True | string |
The unique ID of the Offer Shift request |
Returns
Offer Shift Request Entity
- Offer Shift Request
- OfferShiftRequestResponse
This operation returns details for an Open Shift.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Open Shift ID
|
openShiftId | True | string |
The unique ID of the Open Shift. |
Returns
Open Shift Entity
- Open Shift
- OpenShiftResponse
This operation returns an Open Shift change request by ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Open Shift Change Request ID
|
openShiftChangeRequestId | True | string |
The unique ID of the request |
Returns
Open Shift Change Request Entity
- Open Shift Change Request
- OpenShiftChangeRequestResponse
This operation returns all Offer Shift requests in a Schedule.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Page Size
|
$top | integer |
Items per page (enable Pagination under .../Settings) |
|
Request State
|
state | string |
Request state filter |
Returns
Name | Path | Type | Description |
---|---|---|---|
Offer Shift Requests List
|
value | array of OfferShiftRequestResponse |
List of Offer Shift requests. |
This operation returns all Open Shift change requests in a Schedule.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Page Size
|
$top | integer |
Items per page (enable Pagination under .../Settings) |
|
Request State
|
state | string |
Request state filter |
Returns
Name | Path | Type | Description |
---|---|---|---|
Open Shift Change Requests List
|
value | array of OpenShiftChangeRequestResponse |
List of Open Shift Change Requests. |
This operation returns Open Shifts that need to be filled from all your teams.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
From Start Time
|
startTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
To End Time
|
endTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
Page Size
|
$top | integer |
Items per page (enable Pagination under .../Settings) |
Returns
Name | Path | Type | Description |
---|---|---|---|
Open Shifts List
|
value | array of OpenShiftResponse |
List of Open Shifts |
This operation returns all Open Shifts in a team.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
From Start Time
|
startTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
To End Time
|
endTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
Page Size
|
$top | integer |
Items per page (enable Pagination under .../Settings) |
Returns
Name | Path | Type | Description |
---|---|---|---|
Open Shifts List
|
value | array of OpenShiftResponse |
List of Open Shifts |
This operation returns all Scheduling Groups in a Schedule.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Page Size
|
$top | integer |
Items per page (enable Pagination under .../Settings) |
Returns
Name | Path | Type | Description |
---|---|---|---|
Scheduling Groups List
|
value | array of SchedulingGroupResponse |
List of Scheduling Groups. |
This operation returns assigned Shifts from all your teams.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
From Start Time
|
startTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
To End Time
|
endTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
User Display Name
|
assignedToUserName | string |
Assigned to user with name |
|
Page Size
|
$top | integer |
Items per page (enable Pagination under .../Settings) |
Returns
Name | Path | Type | Description |
---|---|---|---|
Shifts List
|
value | array of ShiftResponse |
List of Shifts |
This operation returns all Shifts assigned to members of a team
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
From Start Time
|
startTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
To End Time
|
endTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
Page Size
|
$top | integer |
Items per page (enable Pagination under .../Settings) |
Returns
Name | Path | Type | Description |
---|---|---|---|
Shifts List
|
value | array of ShiftResponse |
List of Shifts |
This operation returns all Swap Shifts requests in a Schedule.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Page Size
|
$top | integer |
Items per page (enable Pagination under .../Settings) |
|
Request State
|
state | string |
Request state filter |
Returns
Name | Path | Type | Description |
---|---|---|---|
Swap Shifts Change Requests List
|
value | array of SwapShiftsChangeRequestResponse |
List of Swap Shifts Change Requests. |
This operation returns all Time Off instances in a Schedule
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
From Start Time
|
startTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
To End Time
|
endTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
Page Size
|
$top | integer |
Items per page (enable Pagination under .../Settings) |
Returns
Name | Path | Type | Description |
---|---|---|---|
Time Off Instances List
|
value | array of TimeOffResponse |
List of Time Off instances |
This operation returns the list of Time Off Reasons associated with a team.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Page Size
|
$top | integer |
Items per page (enable Pagination under .../Settings) |
Returns
The list of Time Off Reasons.
- List of Time Off Reasons associated with a team
- GetTimeOffReasonsResponse
This operation returns all Time Off requests in a Schedule.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Page Size
|
$top | integer |
Items per page (enable Pagination under .../Settings) |
|
Request State
|
state | string |
Request state filter |
Returns
Name | Path | Type | Description |
---|---|---|---|
Time Off Requests List
|
value | array of TimeOffRequestResponse |
List of Time Off requests. |
This operation returns times when people are off from all your teams.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
From Start Time
|
startTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
To End Time
|
endTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
User Display Name
|
assignedToUserName | string |
Assigned to user with name |
|
Page Size
|
$top | integer |
How many times off to fetch |
Returns
Name | Path | Type | Description |
---|---|---|---|
Times Off List
|
value | array of TimeOffResponse |
List of Times off |
Update an Open Shift in a Schedule.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Open Shift ID
|
openShiftId | True | string |
The unique ID of the Open Shift. |
Scheduling Group ID
|
schedulingGroupId | string |
Scheduling Group ID |
|
Display Name
|
displayName | string |
Display Name |
|
Notes
|
notes | string |
Notes |
|
Start Time
|
startDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Theme
|
theme | string |
Theme color. |
|
Open Slot Count
|
openSlotCount | True | integer |
Open Slot Count |
Is Paid
|
isPaid | boolean |
Is Paid |
|
Start Time
|
startDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | True | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Code
|
code | string |
Code |
|
Display Name
|
displayName | string |
Display Name |
Returns
Open Shift Entity
- Open Shift
- OpenShiftResponse
When a Shift is created, updated or deleted |
This operation triggers when a Shift is created, updated or deleted. |
When a Swap Shifts request is created, updated or deleted |
This operation triggers when a Swap Shifts request is created, updated or deleted. |
When a Time Off request is created, updated or deleted |
This operation triggers when a Time Off request is created, updated or deleted. |
When an Offer Shift request is created, updated or deleted |
This operation triggers when an Offer Shift request is created, updated or deleted. |
When an Open Shift request is created, updated or deleted |
This operation triggers when an Open Shift request is created, updated or deleted. |
This operation triggers when a Shift is created, updated or deleted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Returns
Payload from backend containing subscription metadata as well as data
- Body
- WebhookPushResponse
This operation triggers when a Swap Shifts request is created, updated or deleted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Returns
Payload from backend containing subscription metadata as well as data
- Body
- WebhookPushResponse
This operation triggers when a Time Off request is created, updated or deleted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Returns
Payload from backend containing subscription metadata as well as data
- Body
- WebhookPushResponse
This operation triggers when an Offer Shift request is created, updated or deleted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Returns
Payload from backend containing subscription metadata as well as data
- Body
- WebhookPushResponse
This operation triggers when an Open Shift request is created, updated or deleted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Team
|
teamId | True | string |
Add Team ID |
Returns
Payload from backend containing subscription metadata as well as data
- Body
- WebhookPushResponse
Payload from backend containing subscription metadata as well as data
Name | Path | Type | Description |
---|---|---|---|
value
|
value | array of WebhookNotificationEntity |
List of values |
Name | Path | Type | Description |
---|---|---|---|
Change Type
|
changeType | string |
Resource change type (created/updated/deleted). |
resourceData
|
resourceData | WebhookPushResponseResourceEntity |
Name | Path | Type | Description |
---|---|---|---|
Resource ID
|
id | string |
ID of the resource that is updated. |
Team ID
|
teamId | string |
ID of team where the update happened. |
Schedule Entity.
Name | Path | Type | Description |
---|---|---|---|
Schedule ID
|
id | string |
The unique ID of the Schedule. |
Schedule Time Zone
|
timeZone | string |
The Time Zone of the Schedule. |
Schedule Provision Status
|
provisionStatus | string |
The Provision Status of the Schedule. |
Schedule Provision Status Code
|
provisionStatusCode | string |
The Provision Status Code of the Schedule. |
Time Off Entity.
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the Time Off. |
Created Date Time
|
createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Modified Date Time
|
lastModifiedDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Assigned To User ID
|
userId | string |
Assigned To User ID. |
User Info
|
userInfo | UserInfo |
User Info |
Team Info
|
teamInfo | TeamInfo |
Team Info |
|
sharedTimeOff | SharedTimeOff |
Shared version of the Time Off. |
Draft Changes >
|
draftTimeOff | DraftTimeOff |
Preliminary version of the Time Off |
Shared version of the Time Off.
Name | Path | Type | Description |
---|---|---|---|
Time Off Reason ID
|
timeOffReasonId | string |
Time Off Reason ID. |
Start Time
|
startDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Theme
|
theme | Theme |
Theme color. |
Preliminary version of the Time Off
Name | Path | Type | Description |
---|---|---|---|
Time Off Reason ID
|
timeOffReasonId | string |
Time Off Reason ID. |
Start Time
|
startDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Theme
|
theme | Theme |
Theme color. |
Shift Entity.
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the Shift. |
Created Date Time
|
createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Modified Date Time
|
lastModifiedDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Assigned To User ID
|
userId | string |
Assigned To User ID. |
Scheduling Group ID
|
schedulingGroupId | string |
Scheduling Group ID. |
Scheduling Group Info
|
schedulingGroupInfo | SchedulingGroupInfo |
Scheduling Group Info |
User Info
|
userInfo | UserInfo |
User Info |
Team Info
|
teamInfo | TeamInfo |
Team Info |
|
sharedShift | SharedShift |
Shared version of the Shift. |
Draft Changes >
|
draftShift | DraftShift |
Preliminary version of the Shift |
Shared version of the Shift.
Name | Path | Type | Description |
---|---|---|---|
Display Name
|
displayName | string |
Display Name |
Notes
|
notes | string |
Shift Notes |
Start Time
|
startDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Theme
|
theme | Theme |
Theme color. |
Activities
|
activities | Activities |
Shift activities |
Preliminary version of the Shift
Name | Path | Type | Description |
---|---|---|---|
Display Name
|
displayName | string |
Display Name |
Notes
|
notes | string |
Notes |
Start Time
|
startDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Theme
|
theme | Theme |
Theme color. |
Activities
|
activities | Activities |
Shift activities |
Shift activities
Name | Path | Type | Description |
---|---|---|---|
Is Paid
|
isPaid | boolean |
Is Paid |
Start Time
|
startDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Code
|
code | string |
Code |
Display Name
|
displayName | string |
Display Name |
Scheduling Group Entity
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the Scheduling Group. |
Display Name
|
displayName | string |
The display name for the Scheduling Group. |
Is Active
|
isActive | boolean |
Indicates whether the Scheduling Group can be used when creating new entities or updating existing ones. |
User IDs
|
userIds | array of string |
List of IDs of users in the Scheduling Group. |
Scheduling Group Info
Name | Path | Type | Description |
---|---|---|---|
Scheduling Group Id
|
schedulingGroupId | string |
The unique ID of the Scheduling Group. |
Display Name
|
displayName | string |
The display name for the Scheduling Group. |
Code
|
code | string |
The scheduling group code. |
User Info
Name | Path | Type | Description |
---|---|---|---|
User Id
|
userId | string |
The ID of the user. |
Display Name
|
displayName | string |
The display name of the user. |
Team Info
Name | Path | Type | Description |
---|---|---|---|
Team Id
|
teamId | string |
The ID of the team. |
Display Name
|
displayName | string |
The display name for the team. |
Open Shift Entity
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the Open Shift. |
Created Date Time
|
createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Modified Date Time
|
lastModifiedDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Scheduling Group ID
|
schedulingGroupId | string |
Scheduling Group ID |
Scheduling Group Info
|
schedulingGroupInfo | SchedulingGroupInfo |
Scheduling Group Info |
Team Info
|
teamInfo | TeamInfo |
Team Info |
|
sharedOpenShift | SharedOpenShift |
Shared version of the Open Shift |
Draft Changes >
|
draftOpenShift | DraftOpenShift |
Preliminary version of the Open Shift |
Shared version of the Open Shift
Name | Path | Type | Description |
---|---|---|---|
Display Name
|
displayName | string |
Display Name |
Notes
|
notes | string |
Notes |
Start Time
|
startDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Theme
|
theme | Theme |
Theme color. |
Open Slot Count
|
openSlotCount | integer |
Open Slot Count |
Activities
|
activities | Activities |
Shift activities |
Preliminary version of the Open Shift
Name | Path | Type | Description |
---|---|---|---|
Display Name
|
displayName | string |
Display Name |
Notes
|
notes | string |
Notes |
Start Time
|
startDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
End Time
|
endDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Theme
|
theme | Theme |
Theme color. |
Open Slot Count
|
openSlotCount | integer |
Open Slot Count |
Activities
|
activities | Activities |
Shift activities |
The list of Time Off Reasons.
Name | Path | Type | Description |
---|---|---|---|
Array containing Time Off Reasons
|
value | array of object |
The list of Time Off Reasons. |
Time Off Reason ID
|
value.id | string |
The unique ID of the Time Off Reason. |
Created Time
|
value.createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Modified Date Time
|
value.lastModifiedDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Display Name
|
value.displayName | string |
Display Name |
Icon Type
|
value.iconType | string |
Icon Type |
Is Active
|
value.isActive | boolean |
Is Active |
Time Off Request Entity
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the Time Off request. |
Created Time
|
createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Modified Time
|
lastModifiedDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Assigned To
|
assignedTo | string |
The person the request is assigned to: 'manager' or 'recipient' |
State
|
state | string |
'approved', 'pending' or 'declined' |
Sender Time
|
senderDateTime | date-time |
Time when the request was sent |
Sender Message
|
senderMessage | string |
The message from the request sender |
Sender ID
|
senderUserId | string |
The ID of the user that sent the request |
Manager Action Time
|
managerActionDateTime | date-time |
Time when the manager responded |
Manager Message
|
managerActionMessage | string |
The message from the manager |
Manager ID
|
managerUserId | string |
The ID of the manager that responded |
Start Time
|
startDateTime | date-time |
Start of time requested off |
End Time
|
endDateTime | date-time |
End of time requested off |
Time Off Reason ID
|
timeOffReasonId | string |
The ID of the Time Off Reason |
Offer Shift Request Entity
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the Offer Shift request. |
Created Time
|
createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Modified Time
|
lastModifiedDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Assigned To
|
assignedTo | string |
The person the request is assigned to: 'manager' or 'recipient' |
State
|
state | string |
'approved', 'pending' or 'declined' |
Sender Time
|
senderDateTime | date-time |
Time when the request was sent |
Sender Message
|
senderMessage | string |
The message from the request sender |
Sender ID
|
senderUserId | string |
The ID of the user that sent the request |
Sender Shift ID
|
senderShiftId | string |
The ID of the Shift from the sender |
Receiver Time
|
recipientActionDateTime | date-time |
Time when the recipient responded |
Recipient Message
|
recipientActionMessage | string |
The message from the recipient |
Recipient ID
|
recipientUserId | string |
The ID of the recipient of the request |
Manager Action Time
|
managerActionDateTime | date-time |
Time when the manager responded |
Manager Message
|
managerActionMessage | string |
The message from the manager |
Manager ID
|
managerUserId | string |
The ID of the manager that responded |
Swap Shift Request Entity
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the Swap Shift request. |
Created Time
|
createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Modified Time
|
lastModifiedDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Assigned To
|
assignedTo | string |
The person the request is assigned to: 'manager' or 'recipient' |
State
|
state | string |
'approved', 'pending' or 'declined' |
Sender Time
|
senderDateTime | date-time |
Time when the request was sent |
Sender Message
|
senderMessage | string |
The message from the request sender |
Sender ID
|
senderUserId | string |
The ID of the user that sent the request |
Sender Shift ID
|
senderShiftId | string |
The ID of the Shift from the sender |
Receiver Time
|
recipientActionDateTime | date-time |
Time when the recipient responded |
Recipient Message
|
recipientActionMessage | string |
The message from the recipient |
Recipient ID
|
recipientUserId | string |
The ID of the recipient of the request |
Recipient Shift ID
|
recipientShiftId | string |
The ID of the Shift from the recipient |
Manager Action Time
|
managerActionDateTime | date-time |
Time when the manager responded |
Manager Message
|
managerActionMessage | string |
The message from the manager |
Manager ID
|
managerUserId | string |
The ID of the manager that responded |
Open Shift Change Request Entity
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the Open Shift Change request. |
Created Time
|
createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Modified Time
|
lastModifiedDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Assigned To
|
assignedTo | string |
The person the request is assigned to: 'manager' or 'recipient' |
State
|
state | string |
'approved', 'pending' or 'declined' |
Sender Time
|
senderDateTime | date-time |
Time when the request was sent |
Sender Message
|
senderMessage | string |
The message from the request sender |
Sender ID
|
senderUserId | string |
The ID of the user that sent the request |
Manager Action Time
|
managerActionDateTime | date-time |
Time when the manager responded |
Manager Message
|
managerActionMessage | string |
The message from the manager |
Manager ID
|
managerUserId | string |
The ID of the manager that responded |
Open Shift ID
|
openShiftId | string |
The ID of the Open Shift being requested |