Schedule.Read.All
Allows the app to read all schedules, schedule groups, shifts and associated entities in the Teams or Shifts application without a signed-in user.
Permission Details
Read all schedule items
Allows the app to read all schedules, schedule groups, shifts and associated entities in the Teams or Shifts application without a signed-in user.
7b2ebf90-d836-437f-b90d-7b62722c4456
Read user schedule items
Allows the app to read schedule, schedule groups, shifts and associated entities in the Teams or Shifts application on behalf of the signed-in user.
fccf6dd8-5706-49fa-811f-69e2e1b585d0
Properties
Properties is shown from stable Microsoft Graph v1.0 metadata.
| Property | Type | Description |
|---|---|---|
enabled |
BooleanNullable |
Indicates whether the schedule is enabled for the team. Required. |
id |
string |
ID of the schedule. |
isActivitiesIncludedWhenCopyingShiftsEnabled |
BooleanNullable |
Indicates whether copied shifts include activities from the original shift. |
offerShiftRequestsEnabled |
BooleanNullable |
Indicates whether offer shift requests are enabled for the schedule. |
openShiftsEnabled |
BooleanNullable |
Indicates whether open shifts are enabled for the schedule. |
provisionStatus |
operationStatusRead-only |
The status of the schedule provisioning. The possible values are notStarted, running, completed, failed. |
provisionStatusCode |
stringRead-onlyNullable |
Additional information about why schedule provisioning failed. |
startDayOfWeek |
dayOfWeek |
Indicates the start day of the week. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. |
swapShiftsRequestsEnabled |
BooleanNullable |
Indicates whether swap shifts requests are enabled for the schedule. |
timeClockEnabled |
BooleanNullable |
Indicates whether time clock is enabled for the schedule. |
timeClockSettings |
timeClockSettings |
The time clock location settings for this schedule. |
timeOffRequestsEnabled |
BooleanNullable |
Indicates whether time off requests are enabled for the schedule. |
timeZone |
stringNullable |
Indicates the time zone of the schedule team using tz database format. Required. |
workforceIntegrationIds |
String collection |
The IDs for the workforce integrations associated with this schedule. |
dayNotes |
dayNote collection |
The day notes in the schedule. |
Showing 15 of 25 properties.
JSON Representation
JSON representation is shown from stable Microsoft Graph v1.0 metadata.
{
"@odata.type": "#microsoft.graph.schedule",
"id": "String (identifier)",
"enabled": "Boolean",
"timeZone": "String",
"provisionStatus": "String",
"provisionStatusCode": "String",
"workforceIntegrationIds": [
"String"
],
"timeClockEnabled": "Boolean",
"timeClockSettings": {
"@odata.type": "microsoft.graph.timeClockSettings"
},
"openShiftsEnabled": "Boolean",
"swapShiftsRequestsEnabled": "Boolean",
"offerShiftRequestsEnabled": "Boolean",
"timeOffRequestsEnabled": "Boolean",
"startDayOfWeek": "String",
"isActivitiesIncludedWhenCopyingShiftsEnabled": "Boolean"
}
Relationships
Relationships is shown from stable Microsoft Graph v1.0 metadata.
| Relationship | Type | Description |
|---|---|---|
dayNotes |
dayNote collection |
The day notes in the schedule. |
offerShiftRequests |
offerShiftRequest collection |
The offer requests for shifts in the schedule. |
openShiftChangeRequests |
openShiftChangeRequest collection |
The open shift requests in the schedule. |
openShifts |
openShift collection |
The set of open shifts in a scheduling group in the schedule. |
schedulingGroups |
schedulingGroup collection |
The logical grouping of users in the schedule (usually by role). |
shifts |
shift collection |
The shifts in the schedule. |
swapShiftsChangeRequests |
swapShiftsChangeRequest collection |
The swap requests for shifts in the schedule. |
timeCards |
timeCard collection |
The time cards in the schedule. |
timesOff |
timeOff collection |
The instances of times off in the schedule. |
timeOffReasons |
timeOffReason collection |
The set of reasons for a time off in the schedule. |
timeOffRequests |
timeOffRequest collection |
The time off requests in the schedule. |
workforceIntegrations |
workforceIntegration collection |
An instance of a workforce integration per team with outbound data flow on synchronous change notifications (for supported entities). |
workforceIntegrationIds |
string collection |
The IDs for the workforce integrations associated with this schedule. |
shiftsRoleDefinitions |
shiftsRoleDefinition collection |
The definitions of the roles in the schedule. |
Graph Methods
Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.
Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.
Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.
Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.
Code Examples
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Teams["{team-id}"].Schedule.OfferShiftRequests["{offerShiftRequest-id}"].GetAsync();
const options = {
authProvider,
};
const client = Client.init(options);
let offerShiftRequest = await client.api('/teams/{teamId}/schedule/offerShiftRequests/{offerShiftRequestId}')
.get();
Import-Module Microsoft.Graph.Teams
Get-MgTeamScheduleOfferShiftRequest -TeamId $teamId -OfferShiftRequestId $offerShiftRequestId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.teams.by_team_id('team-id').schedule.offer_shift_requests.by_offer_shift_request_id('offerShiftRequest-id').get()
App Registration
Navigate to Azure Portal
Go to App registrations in Microsoft Entra admin center
Add API Permission
Select your app → API permissions → Add a permission → Microsoft Graph
Select Permission Type
Choose Application permissions or delegated permissions and search for Schedule.Read.All
Grant Admin Consent
Application permissions always require admin consent.