Connectors Reference
Microsoft StaffHub is a cloud-based platform that works across all your devices. It enables firstline workers and their managers to manage time, communicate with their teams, and share content.
|
Status: Preview |
Tier: Standard |
Version: v1 |
|
Name |
Summary |
|
List all members in a team |
|
|
Get a team member by ID |
|
|
List all groups in a team |
|
|
List the user's teams |
|
|
Get team details |
|
|
Determine the location of the user's data |
|
|
Get current account |
|
|
Get Schedule details |
|
|
Get shift requests |
|
|
Get Shift Request details |
|
|
Approve or deny a time off request (managers only) |
|
|
Approve a shift swap or hand off request (managers only) |
|
|
ListShifts (string teamId, [advanced][Optional]string startTime, [advanced][Optional]string endTime) |
List all team shifts |
|
Delete WebHook Subscription |
|
|
Get Shift |
|
|
Get Time Off Reasons |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List all members in a team
Description: This operation lists all the members of a given team.
Syntax:
MicrosoftStaffHub.ListMembers (string teamId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
Returns:
Type:ListMembersResponse
Description: Get members response
Summary: Get a team member by ID
Description: This operation gets a member of a team by their unique ID.
Syntax:
MicrosoftStaffHub.GetMember (string teamId, string memberId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
memberId |
string (Member ID) |
The id of the member. |
True |
Returns:
Type:GetMemberResponse
Description: Get member response
Summary: List all groups in a team
Description: This operation lists all groups within a team.
Syntax:
MicrosoftStaffHub.ListTags (string teamId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
Returns:
Type:GetTagsResponse
Description: Get tags response
Summary: List the user's teams
Description: This operation lists all teams that the user is a member of.
Syntax:
MicrosoftStaffHub.ListTeams ()
Returns:
Type:GetTeamsResponse
Description: Get teams response
Summary: Get team details
Description: This operation returns details for a team using the team's unique ID.
Syntax:
MicrosoftStaffHub.GetTeam (string teamId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
Returns:
Type:GetTeamResponse
Description: Get team response
Summary: Determine the location of the user's data
Description:
Syntax:
MicrosoftStaffHub.LocateAccount ()
Returns:
Type:LocateUserResponse
Description: Response to the locate user request.
Summary: Get current account
Description: Get the account of the current logged in user.
Syntax:
MicrosoftStaffHub.GetCurrentAccountAccount ()
Returns:
Type:GetCurrentAccountResponse
Description: Get Current Account response
Summary: Get Schedule details
Description: This operation returns details of a schedule using the schedule's unique ID.
Syntax:
MicrosoftStaffHub.GetSchedule (string teamId, string scheduleId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
scheduleId |
string (Schedule ID) |
Unique ID of the schedule. |
True |
Returns:
Description: Schedule Entity
Summary: Get shift requests
Description: This operation returns all shift requests for a team using the team's unique ID.
Syntax:
MicrosoftStaffHub.ListShiftRequests (string teamId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
Returns:
Description: Get Shift Request response
Summary: Get Shift Request details
Description: This operation returns details for a shift request using the request's unique ID.
Syntax:
MicrosoftStaffHub.GetShiftRequest (string teamId, string shiftRequestId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
shiftRequestId |
string (Shift Request ID) |
Unique ID of the shift request. |
True |
Returns:
Type:CreateSwapHandoffShiftResponse
Description: Properties associated with a shift request.
Summary: Approve or deny a time off request (managers only)
Description: This operation allows managers to approve or deny a time off request.
Syntax:
MicrosoftStaffHub.TimeOffManagerRequestComplete (string teamId, string shiftRequestId, TimeOffManagerRequestCompleteRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
shiftRequestId |
string (Shift Request ID) |
The unique ID of the time off request |
True |
|
|
request |
TimeOffManagerRequestCompleteRequest
|
Manager approves or denies a time off request. |
True |
Returns:
Type:TimeOffManagerRequestCompleteResponse
Description: Properties associated with a manager's time off approval.
Summary: Approve a shift swap or hand off request (managers only)
Description: This operation allows managers to approve a shift swap or hand off request.
Syntax:
MicrosoftStaffHub.SwapHandOffManagerAccept (string teamId, string shiftRequestId, SwapHandOffRequestManagerAcceptRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
shiftRequestId |
string (Shift Request ID) |
The unique ID of the shift swap or hand off request |
True |
|
|
request |
SwapHandOffRequestManagerAcceptRequest
|
Manager approves a swap or hand off request. |
True |
Returns:
Type:SwapHandOffRequestManagerAcceptResponse
Description: Properties associated with a manager's swap or hand off request approval.
Summary: List all team shifts
Description: This operation returns all shifts assigned to members of a team
Syntax:
MicrosoftStaffHub.ListShifts (string teamId, [advanced][Optional]string startTime, [advanced][Optional]string endTime)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
startTime |
string(date-time) (From Start Time) |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
False |
|
|
endTime |
string(date-time) (To End Time) |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
False |
Returns:
Type:GetShiftsResponse
Description: Get shifts response
Summary: Delete WebHook Subscription
Description: Delete WebHook Subscription
Syntax:
MicrosoftStaffHub.DeleteWebHookSubscription (string subscriptionId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string
|
|
True |
Returns:
Summary: Get Shift
Description: This operation returns details for a shift using the shift's unique ID.
Syntax:
MicrosoftStaffHub.GetShift (string teamId, string shiftId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
shiftId |
string (Shift ID) |
The unique ID of the shift. |
True |
Returns:
Type:CreateShiftResponse
Description: Properties associated with a shift.
Summary: Get Time Off Reasons
Description: This operation returns the list of time off reasons associated with a team.
Syntax:
MicrosoftStaffHub.ListTimeOffReasons (string teamId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
Returns:
Type:GetTimeOffReasonsResponse
Description: Properties associated with time off reasons.
Summary: When a new member is added to the team
Description: This operation triggers when a new member is added to the team.
Syntax:
MicrosoftStaffHub.SubscribeWebHookNotificationsForMemberCreated (string teamId, WebHookRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
request |
|
|
True |
Returns:
Type:SubscribeWebHookNotificationsForMemberCreatedResponse
Summary: When a member is updated in the team
Description: This operation triggers when a team member is updated.
Syntax:
MicrosoftStaffHub.SubscribeWebHookNotificationsForMemberUpdated (string teamId, WebHookRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
request |
|
|
True |
Returns:
Type:SubscribeWebHookNotificationsForMemberUpdatedResponse
Summary: When a member is deleted from the team
Description: This operation triggers when a member is deleted from the team.
Syntax:
MicrosoftStaffHub.SubscribeWebHookNotificationsForMemberDeleted (string teamId, WebHookRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
request |
|
|
True |
Returns:
Type:SubscribeWebHookNotificationsForMemberDeletedResponse
Summary: When a schedule is published for the team
Description: This operation triggers when a schedule is published for the team.
Syntax:
MicrosoftStaffHub.SubscribeWebHookNotificationsForSchedulePublished (string teamId, WebHookRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
request |
|
|
True |
Returns:
Type:SubscribeWebHookNotificationsForSchedulePublishedResponse
Summary: When a new shift request is created
Description: This operation triggers when a new swap, offer or time off shift request is created.
Syntax:
MicrosoftStaffHub.SubscribeWebHookNotificationsForShiftRequestCreated (string teamId, WebHookRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
request |
|
|
True |
Returns:
Type:SubscribeWebHookNotificationsForShiftRequestCreatedResponse
Summary: When a shift request is updated
Description: This operation triggers when a swap, offer or time off shift request is updated.
Syntax:
MicrosoftStaffHub.SubscribeWebHookNotificationsForShiftRequestUpdated (string teamId, WebHookRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
request |
|
|
True |
Returns:
Type:SubscribeWebHookNotificationsForShiftRequestUpdatedResponse
Summary: When a shift request is deleted
Description: This operation triggers when a swap, offer or time off shift request is deleted.
Syntax:
MicrosoftStaffHub.SubscribeWebHookNotificationsForShiftRequestDeleted (string teamId, WebHookRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
request |
|
|
True |
Returns:
Type:SubscribeWebHookNotificationsForShiftRequestDeletedResponse
Summary: When a new shift is added to the team
Description: This operation triggers when a new shift is added to a member of a team.
Syntax:
MicrosoftStaffHub.SubscribeWebHookNotificationsForShiftCreated (string teamId, WebHookRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
request |
|
|
True |
Returns:
Type:SubscribeWebHookNotificationsForShiftCreatedResponse
Summary: When a shift is updated in a team
Description: This operation triggers when a shift is updated for a member of a team.
Syntax:
MicrosoftStaffHub.SubscribeWebHookNotificationsForShiftUpdated (string teamId, WebHookRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
request |
|
|
True |
Returns:
Type:SubscribeWebHookNotificationsForShiftUpdatedResponse
Summary: When a shift is deleted in a team
Description: This operation triggers when a shift is deleted for a member of a team.
Syntax:
MicrosoftStaffHub.SubscribeWebHookNotificationsForShiftDeleted (string teamId, WebHookRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (The team ID) |
Unique ID of the team. |
True |
|
|
request |
|
|
True |
Returns:
Type:SubscribeWebHookNotificationsForShiftDeletedResponse
Summary:
Description: Schedule Entity
Properties:
|
Name |
Type |
Summary |
|
schedule |
|
Properties associated with a schedule. |
Summary:
Description: Properties associated with a schedule.
Properties:
|
Name |
Type |
Summary |
|
id |
string Schedule ID |
The unique ID of the schedule. |
|
teamId |
string Team ID |
The unique ID of the team the schedule is in. |
|
startTime |
string(date-time) Start Time |
The start time of the schedule. |
|
endTime |
string(date-time) End Time |
The end time of the schedule. |
|
state |
string Schedule State |
The current state of the schedule. Values: [Draft, Published, Deleted] |
Summary:
Description: Properties associated with a shift.
Properties:
|
Name |
Type |
Summary |
|
shift |
|
Properties associated with a shift. |
|
isShiftPublished |
boolean Is Shift Published |
Whether the shift is part of a published schedule. |
Summary:
Description: Properties associated with a shift.
Properties:
|
Name |
Type |
Summary |
|
id |
string Shift ID |
The unique ID of the shift. |
|
title |
string Shift Title |
The label of the shift. |
|
shiftType |
string Shift Type |
The type of shift. Values: [Working, Absence] |
|
teamId |
string Team ID |
The ID of the team the shift is in |
|
memberId |
string Assigned To Member ID |
The unique ID of the team member that the shift has been assigned to. |
|
startTime |
string(date-time) Shift Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endTime |
string(date-time) Shift End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
notes |
string Shift Notes |
The notes assigned to the shift. |
|
state |
string Shift State |
The current state of the shift. Values: [Draft, Active, Pending, Deleted] |
|
timeOffReasonId |
string Time Off Reason ID |
The unique ID of the time off reason. |
Summary:
Description: Properties associated with a shift request.
Properties:
|
Name |
Type |
Summary |
|
shiftRequest |
|
Properties associated with a shift request. |
Summary:
Description: Properties associated with a shift request.
Properties:
|
Name |
Type |
Summary |
|
id |
string Shift Request ID |
The unique ID associated with the shift request. |
|
shiftId |
string Shift ID |
The unique ID of the shift being offered or swapped. |
|
teamId |
string Team ID |
The unique ID of the team. |
|
requestType |
string Shift Request Type |
The type of shift request. Values: [Unspecified, HandOff, Swap, TimeOff, Open] |
|
startTime |
string(date-time) Shift Request Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endTime |
string(date-time) Shift Request End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
senderMessage |
string Message From Sender |
The message from the sender to the recipient. |
|
receiverMessage |
string Message From Receiver |
The message from the receiver to the sender. |
|
managerMessage |
string Message From Manager |
The message from the manager to the sender. |
|
managerMemberId |
string Manager Member ID |
The unique ID of the manager who accepted the request. |
|
senderMemberId |
string Sender Member ID |
The unique ID of the team member who created the request. |
|
receiverMemberId |
string Receiver Member ID |
The unique ID of the member that the request was sent to. |
|
state |
string Shift Request State |
The current state of the shift request. Values: [Unknown, WaitingOnReceiver, WaitingOnManager, SenderDeclined, ReceiverDeclined, ManagerApproved, ManagerDeclined, AutoDeclined, AnotherApproved] |
|
creationTime |
string(date-time) Shift Request Creation Time |
The time when the request was created. |
|
lastModifiedTime |
string(date-time) Shift Request Last Modified Time |
The time when the request was last modified. |
|
receiverResponseTime |
string(date-time) Shift Request Receiver Response Time |
The time when the recipient responded to the request. |
|
timeOffReasonId |
string Time Off Reason ID |
The unique ID of the time off reason |
|
otherShiftInfo |
|
Properties associated with a shift. |
|
eTag |
string ETag of Shift Request |
The version number used to update the shift request. |
Summary:
Description: Properties associated with a shift.
Properties:
|
Name |
Type |
Summary |
|
shiftId |
string Shift ID |
The unique ID of the shift. |
|
startTime |
string(date-time) Shift Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endTime |
string(date-time) Shift End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
Summary:
Description: Get Current Account response
Properties:
|
Name |
Type |
Summary |
|
user |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
userId |
string User ID |
The unique ID of the user in the directory. |
|
displayName |
string Display Name |
The display name of the user. |
|
firstName |
string First Name |
The first name of the user. |
|
lastName |
string Last Name |
The last name of the user. |
|
primaryEmail |
string Primary Email |
The primary email address of the user. |
|
tenantId |
string Tenant ID |
Tenant ID of the user. |
|
phoneNumber |
string Phone Number |
The phone number of the user. |
Summary:
Description: Get member response
Properties:
|
Name |
Type |
Summary |
|
member |
|
Properties associated with a single team member. |
Summary:
Description: Properties associated with a single team member.
Properties:
|
Name |
Type |
Summary |
|
id |
string Member ID |
The unique ID of the team member. |
|
teamId |
string Team ID |
The unique ID of the team. |
|
userId |
string User ID |
The user ID of the team member |
|
displayName |
string Display Name |
The display name of the team member. |
|
firstName |
string First Name |
The first name of the team member. |
|
lastName |
string Last Name |
The last name of the team member. |
|
fullName |
string Full Name |
The full name of the team member. |
|
|
string |
The email address of the team member. |
|
phoneNumber |
string Phone Number |
The phone number of the team member. |
|
isManager |
boolean Is Manager |
Whether or not the team member is a manager of the team. |
|
state |
string Member State |
The status of the user's membership in the team. Values: [Invited, Active, InviteRejected, Deleted, AutoDeleted] |
Summary:
Description: Get Shift Request response
Properties:
|
Name |
Type |
Summary |
|
shiftRequests |
array of (ShiftRequestsItem) Shift Requests Array |
The list of shift requests in the team. |
Summary:
Description: Properties associated with a shift request.
Properties:
|
Name |
Type |
Summary |
|
id |
string Shift Request ID |
The unique ID of the shift request |
|
shiftId |
string Shift ID |
The unique ID of the shift being handed off/swapped. |
|
teamId |
string Team ID |
The unique ID of the team the shift request is in. |
|
requestType |
string Request Type |
The type of the shift request. Values: [Unspecified, HandOff, Swap, TimeOff, Open] |
|
startTime |
string(date-time) Request Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endTime |
string(date-time) Request End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
senderMessage |
string Message From Sender |
The message from the sender to the recipient. |
|
receiverMessage |
string Message From Receiver |
The message from the recipient to the sender. |
|
managerMessage |
string Message From Manager |
A message from the manager to the sender. |
|
managerMemberId |
string Member ID of Manager |
The unique ID of the manager who accepted the request. |
|
senderMemberId |
string Member ID of Sender |
The unique ID of the team member who created the request. |
|
receiverMemberId |
string Member ID of Receiver |
The unique ID of the team member that the request was sent to. |
|
state |
string Shift Request State |
The current state of the shift request. Values: [Unknown, WaitingOnReceiver, WaitingOnManager, SenderDeclined, ReceiverDeclined, ManagerApproved, ManagerDeclined, AutoDeclined, AnotherApproved] |
|
creationTime |
string(date-time) Shift Request Creation Time |
The time the request was created. |
|
lastModifiedTime |
string(date-time) Last Modified Time of Shift Request |
The time the request was last modified. |
|
receiverResponseTime |
string(date-time) Receiver Response Time |
The time the recipient responded to the request. |
|
timeOffReasonId |
string Time Off Reason ID |
The unique ID of the time off reason |
|
otherShiftInfo |
|
Properties associated with a single shift. |
|
eTag |
string ETag of Shift Request |
The version number used to update the shift request. |
Summary:
Description: Properties associated with a single shift.
Properties:
|
Name |
Type |
Summary |
|
shiftId |
string Shift ID |
The unique ID of the shift. |
|
startTime |
string(date-time) Shift Start Time |
The start time of the shift. |
|
endTime |
string(date-time) Shift End Time |
The end time of the shift. |
Summary:
Description: Get shifts response
Properties:
|
Name |
Type |
Summary |
|
publishedShifts |
array of (PublishedShiftsItem) Published Shifts Array |
The list of published shifts for a team. |
|
unpublishedShifts |
array of (UnpublishedShiftsItem) Unpublished Shifts Array |
The list of unpublished shifts for a team. |
Summary:
Description: Properties associated with a single shift.
Properties:
|
Name |
Type |
Summary |
|
id |
string Published Shift ID |
The unique ID of the shift. |
|
title |
string Published Shift Label |
The label of the shift. |
|
shiftType |
string Published Shift Type |
The type of the shift. Values: [Working, Absence] |
|
teamId |
string Team ID |
The ID of the team the shift is in |
|
memberId |
string Assigned to Member ID |
The ID of the team member that the shift is assigned to. |
|
startTime |
string(date-time) Published Shift Start Time |
The start time of the shift. |
|
endTime |
string(date-time) Published Shift End Time |
The end time of the shift. |
|
notes |
string Published Shift Notes |
The notes assigned to the shift. |
|
state |
string Published Shift State |
The state of the shift. Values: [Draft, Active, Pending, Deleted] |
|
timeOffReasonId |
string Time Off Reason ID |
The ID of the time off reason for a shift (if of type Absence). |
Summary:
Description: Properties associated with a single shift.
Properties:
|
Name |
Type |
Summary |
|
id |
string Unpublished Shift ID |
The unique ID of the shift. |
|
title |
string Unpublished Shift Title |
The label of the shift. |
|
shiftType |
string Unpublished Shift Type |
The type of the shift. Values: [Working, Absence] |
|
teamId |
string Team ID |
The ID of the team the shift is in. |
|
memberId |
string Assigned to Member ID |
The ID of the team member that the shift is assigned to. |
|
startTime |
string(date-time) Unpublished Shift Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endTime |
string(date-time) Unpublished Shift End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
notes |
string Unpublished Shift Notes |
The notes assigned to the shift. |
|
state |
string Unpublished Shift State |
The state of the shift. Values: [Draft, Active, Pending, Deleted] |
|
timeOffReasonId |
string Time Off Reason ID |
The ID of the time off reason for a shift (if shift is of type Absence). |
Summary:
Description: Get tags response
Properties:
|
Name |
Type |
Summary |
|
tags |
array of (TagsItem)
|
The list of groups in the team. |
Summary:
Description: Properties associated with a single group in the team.
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
The unique ID of the group. |
|
name |
string
|
The name of the group. |
|
teamId |
string
|
The unique ID of the team. |
|
tenantId |
string
|
The ID of the tenant |
|
state |
string
|
The status of the group in the team. Values: [Active, Deleted] |
|
index |
integer(int32)
|
Tag sort index (client side enforced) |
|
eTag |
string
|
The version of the data row |
Summary:
Description: Get team response
Properties:
|
Name |
Type |
Summary |
|
team |
|
Properties associated with a team. |
Summary:
Description: Properties associated with a team.
Properties:
|
Name |
Type |
Summary |
|
id |
string Team ID |
The unique ID of the team. |
|
name |
string Team Name |
The name of the team. |
|
timeZone |
string TimeZone of team |
The timeZone Olson Code of the Team. |
Summary:
Description: Get teams response
Properties:
|
Name |
Type |
Summary |
|
teams |
array of (TeamsItem)
|
The list of teams. |
Summary:
Description: Properties associated with a single team.
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
The unique ID of the team. |
|
tenantId |
string
|
The tenant ID |
|
handle |
string
|
The team handle (unique user-readable team ID) |
|
name |
string
|
The name of the team. |
|
pictureUrl |
string
|
The icon of the team. |
|
teamType |
string
|
Team type Values: [Unmanaged, Managed] |
|
location |
string
|
The location of the team (this is the name of the department) |
|
countryCode |
string
|
A two letter country code (ISO standard 3166) of the team. This is used to to enforce license restrictions for the users in this team |
|
groupDriveId |
string
|
The identifier for the drive associated to the group provisioned for this team. |
|
groupId |
string
|
The identifier to the group provisioned for this team. |
|
driveProvisionState |
string
|
State of drive provisioning. Values: [Unattempted, Success, Failed, FailedNoLicense] |
|
eTag |
string
|
The etag of the team |
Summary:
Description: Properties associated with time off reasons.
Properties:
|
Name |
Type |
Summary |
|
timeOffReasons |
array of (TimeOffReasonsItem) Time Off Reasons Array |
The list of time off reasons. |
Summary:
Description: Properties associated with a single time off reason.
Properties:
|
Name |
Type |
Summary |
|
id |
string Time Off Reason ID |
The unique ID of the time off reason. |
|
teamId |
string Team ID |
The unique ID of the team. |
|
name |
string Time Off Reason Name |
The name of the time off reason. |
|
state |
string Time Off Reason State |
The current state of the time off reason. Values: [Active, Deleted] |
Summary:
Description: Get members response
Properties:
|
Name |
Type |
Summary |
|
members |
array of (MembersItem) Members Array |
The list of team members. |
Summary:
Description: Properties associated with a single team member.
Properties:
|
Name |
Type |
Summary |
|
id |
string Member ID |
The unique ID of the team member. |
|
teamId |
string Team ID |
The unique ID of the team. |
|
userId |
string User ID |
The unique ID of the user in the directory. |
|
displayName |
string Display Name |
The display name of the team member. |
|
firstName |
string First Name |
The first name of the team member. |
|
lastName |
string Last Name |
The last name of the team member. |
|
fullName |
string Full Name |
The full name of the team member. |
|
|
string |
The email address of the team member. |
|
phoneNumber |
string Phone Number |
The phone number of the team member. |
|
isManager |
boolean Is Manager |
Whether or not the team member is a manager of the team. |
|
state |
string Member State |
The status of the user's membership in the team. Values: [Invited, Active, InviteRejected, Deleted, AutoDeleted] |
Summary:
Description: Response to the locate user request.
Properties:
|
Name |
Type |
Summary |
|
userId |
string User ID |
The User Id |
|
|
string |
Email of the account |
|
region |
|
Encapsulates the region response entity. |
Summary:
Description: Encapsulates the region response entity.
Properties:
|
Name |
Type |
Summary |
|
id |
string Region ID |
The region ID |
|
serviceUrl |
string Service URL |
The service URL for the data in the region |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Manager approves a swap or hand off request.
Properties:
|
Name |
Type |
Summary |
|
message |
string Message From Manager |
A message from the manager to the sender/recipient when a request is accepted |
|
eTag |
string ETag of Shift Request |
The version number used to update the swap or hand off request. |
Summary:
Description: Properties associated with a manager's swap or hand off request approval.
Properties:
|
Name |
Type |
Summary |
|
deletedShifts |
array of (DeletedShiftsItem) List of shifts deleted |
List of shifts deleted |
|
replacementShifts |
array of (ReplacementShiftsItem) List of shifts created as replacement |
List of shifts created as replacement |
|
updatedShiftRequests |
array of (UpdatedShiftRequestsItem) List of shifts Request that got updated |
List of Shift Request that got updated |
Summary:
Description: Properties associated with a shift.
Properties:
|
Name |
Type |
Summary |
|
id |
string Deleted Shift ID |
The unique ID of the shift. |
|
shiftType |
string Deleted Shift Type |
The type of shift. Values: [Working, Absence] |
|
teamId |
string Team ID |
The unique ID of the team |
|
memberId |
string Member ID |
The unique ID of the team member that the shift was assigned to. |
|
startTime |
string(date-time) Deleted Shift Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endTime |
string(date-time) Deleted Shift End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
notes |
string Deleted Shift Notes |
The label of the shift. |
|
state |
string Deleted Shift State |
The current state of the shift. Values: [Draft, Active, Pending, Deleted] |
|
timeOffReasonId |
string Time Off Reason ID of Deleted Shift |
The unique ID of the time off reason. |
Summary:
Description: Properties associated with a shift.
Properties:
|
Name |
Type |
Summary |
|
id |
string Replacement Shift ID |
The unique ID of the shift. |
|
shiftType |
string Replacement Shift Type |
The type of shift. Values: [Working, Absence] |
|
teamId |
string Team ID |
The unique ID of the team |
|
memberId |
string Member ID |
The unique ID of the team member that the shift was assigned to. |
|
startTime |
string(date-time) Replacement Shift Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endTime |
string(date-time) Replacement Shift End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
notes |
string Replacement Shift Notes |
The label of the shift. |
|
state |
string Replacement Shift State |
The current state of the shift. Values: [Draft, Active, Pending, Deleted] |
|
timeOffReasonId |
string Time Off Reason ID of Replacement Shift |
The unique ID of the time off reason. |
Summary:
Description: Properties associated with a shift request
Properties:
|
Name |
Type |
Summary |
|
id |
string Shift Request ID |
The unique ID of the shift request |
|
shiftId |
string Shift ID |
The unique ID of the shift being handed off/swapped. |
|
teamId |
string Team ID |
The unique ID of the team the shift request is in. |
|
requestType |
string Request Type |
The type of the shift request. Values: [Unspecified, HandOff, Swap, TimeOff, Open] |
|
startTime |
string(date-time) Request Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endTime |
string(date-time) Request End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
senderMessage |
string Message From Sender |
The message from the sender to the recipient. |
|
receiverMessage |
string Message From Receiver |
The message from the recipient to the sender. |
|
managerMessage |
string Message From Manager |
A message from the manager to the sender. |
|
managerMemberId |
string Member ID of Manager |
The unique ID of the manager who accepted the request. |
|
senderMemberId |
string Member ID of Sender |
The unique ID of the team member who created the request. |
|
receiverMemberId |
string Member ID of Receiver |
The unique ID of the team member that the request was sent to. |
|
state |
string Shift Request State |
The current state of the shift request. Values: [Unknown, WaitingOnReceiver, WaitingOnManager, SenderDeclined, ReceiverDeclined, ManagerApproved, ManagerDeclined, AutoDeclined, AnotherApproved] |
|
creationTime |
string(date-time) Shift Request Creation Time |
The time the request was created. |
|
lastModifiedTime |
string(date-time) Last Modified Time of Shift Request |
The time the request was last modified. |
|
receiverResponseTime |
string(date-time) Receiver Response Time |
The time the recipient responded to the request. |
|
timeOffReasonId |
string Time Off Reason ID |
The unique ID of the time off reason |
|
otherShiftInfo |
|
Properties associated with a single shift. |
|
eTag |
string ETag of Shift Request |
The version number used to update the shift request. |
Summary:
Description: Properties associated with a single shift.
Properties:
|
Name |
Type |
Summary |
|
shiftId |
string Shift ID |
The unique ID of the shift. |
|
startTime |
string(date-time) Shift Start Time |
The start time of the shift. |
|
endTime |
string(date-time) Shift End Time |
The end time of the shift. |
Summary:
Description: Manager approves or denies a time off request.
Properties:
|
Name |
Type |
Summary |
|
message |
string Message From Manager |
A message from the manager to the sender/recipient when a request is accepted or denied. |
|
eTag |
string ETag of Shift Request |
The version number used to update the time off request. |
|
isAccepting |
boolean Is Accepting |
Whether the manager is accepting (True) or denying (False) the time off request. |
Summary:
Description: Properties associated with a manager's time off approval.
Properties:
|
Name |
Type |
Summary |
|
updatedShift |
|
Properties associated with a shift. |
|
isShiftPublished |
boolean Is Updated Shift Published |
Whether the shift is part of a published schedule. |
Summary:
Description: Properties associated with a shift.
Properties:
|
Name |
Type |
Summary |
|
id |
string Updated Shift ID |
The unique ID of the shift. |
|
shiftType |
string Updated Shift Type |
The type of shift. Values: [Working, Absence] |
|
teamId |
string Team ID |
The unique ID of the team |
|
memberId |
string Member ID |
The unique ID of the team member that the shift was assigned to. |
|
startTime |
string(date-time) Updated Shift Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endTime |
string(date-time) Updated Shift End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
notes |
string Updated Shift Notes |
The label of the shift. |
|
state |
string Updated Shift State |
The current state of the shift. Values: [Draft, Active, Pending, Deleted] |
|
timeOffReasonId |
string Time Off Reason ID of Updated Shift |
The unique ID of the time off reason. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
notificationUrl |
string Notification URL |
Webhook subscription notification URL. |