ESC
Type to search...

Schedule.Read.All

Export JSON
Export CSV
Copy URL
Print
ApplicationDelegated Read All Resources

Allows the app to read all schedules, schedule groups, shifts and associated entities in the Teams or Shifts application without a signed-in user.

Delegated Access App-Only Access

Permission Details

Application Permission

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.

Delegated Permission Admin consent required

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.

Properties

Property Type Description
id string The unique identifier for an entity. Read-only.
timeClockEnabled booleanNullable Indicates whether time clock is enabled for the schedule.
swapShiftsChangeRequests microsoft.graph.swapShiftsChangeRequest collection The swap requests for shifts in the schedule.
openShiftChangeRequests microsoft.graph.openShiftChangeRequest collection The open shift requests in the schedule.
enabled booleanNullable Indicates whether the schedule is enabled for the team. Required.
dayNotes microsoft.graph.dayNote collection The day notes in the schedule.
openShifts microsoft.graph.openShift collection The set of open shifts in a scheduling group in the schedule.
activitiesIncludedWhenCopyingShiftsEnabled booleanNullable Indicates whether copied shifts should include the activities. This property will be removed by November 20, 2027. Use isActivitiesIncludedWhenCopyingShiftsEnabled instead. activitiesIncludedWhenCopyingShiftsEnabled and isActivitiesIncludedWhenCopyingShiftsEnabled always have the same value, so setting one automatically sets the value for the other. If both are included in the request with different values, the value for isActivitiesIncludedWhenCopyingShiftsEnabled takes precedence.
openShiftsEnabled booleanNullable Indicates whether open shifts are enabled for the schedule.
timeOffRequestsEnabled booleanNullable Indicates whether time off requests are enabled for the schedule.
shifts microsoft.graph.shift collection The shifts in the schedule.
timesOff microsoft.graph.timeOff collection The instances of times off in the schedule.
isCrossLocationShiftRequestApprovalRequired booleanNullable Indicates whether approval is required by a manager of this schedule for cross location shift requests.
startDayOfWeek object Indicates the start day of the week. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday.
offerShiftRequestsEnabled booleanNullable Indicates whether offer shift requests are enabled for the schedule.

Showing 15 of 29 properties. View all on Microsoft Learn →

JSON Representation

JSON representation
{
  "id": "String",
  "timeClockEnabled": "Boolean",
  "swapShiftsChangeRequests": "[...]",
  "openShiftChangeRequests": "[...]",
  "enabled": "Boolean",
  "dayNotes": "[...]",
  "openShifts": "[...]",
  "activitiesIncludedWhenCopyingShiftsEnabled": "Boolean",
  "openShiftsEnabled": "Boolean",
  "timeOffRequestsEnabled": "Boolean",
  "shifts": "[...]",
  "timesOff": "[...]",
  "isCrossLocationShiftRequestApprovalRequired": "Boolean",
  "startDayOfWeek": "{...}",
  "offerShiftRequestsEnabled": "Boolean",
  "shiftsRoleDefinitions": "[...]",
  "timeCards": "[...]",
  "isCrossLocationShiftsEnabled": "Boolean",
  "timeOffRequests": "[...]",
  "provisionStatus": "{...}"
}

Relationships

Relationship Type Description
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.
timeOffReasons timeOffReason collection The set of reasons for a time off in the schedule.
timeOffRequests timeOffRequest collection The time off requests in the schedule.
timesOff timeOff collection The instances of times off in the schedule.

Graph Methods

Delegated access App-only access
Methods
GET /subscriptions
GET /subscriptions/{id}
GET /teams/{id}/schedule/openShiftChangeRequests
GET /teams/{id}/schedule/openShiftChangeRequests/{openShiftsChangeRequestId}
GET /teams/{id}/schedule/openShifts
GET /teams/{id}/schedule/openShifts/{openShiftId}
GET /teams/{teamId}/schedule
GET /teams/{teamId}/schedule/offerShiftRequests/{offerShiftRequestId}
GET /teams/{teamId}/schedule/schedulingGroups
GET /teams/{teamId}/schedule/schedulingGroups/{schedulingGroupId}
GET /teams/{teamId}/schedule/shifts
GET /teams/{teamId}/schedule/shifts/{shiftId}
GET /teams/{teamId}/schedule/swapShiftsChangeRequests
GET /teams/{teamId}/schedule/timeOffReasons
GET /teams/{teamId}/schedule/timeOffReasons/{timeOffReasonId}
GET /teams/{teamId}/schedule/timeOffRequests
GET /teams/{teamId}/schedule/timeOffRequests/{timeOffRequestId}
GET /teams/{teamId}/schedule/timesOff
GET /teams/{teamId}/schedule/timesOff/{timeOffId}
GET /teams/{teamsId}/schedule/dayNotes
GET /teams/{teamsId}/schedule/dayNotes/{dayNoteId}
GET /teams/{teamsId}/schedule/timeCards
GET /teams/{teamsId}/schedule/timeCards/{timeCardId}
POST /subscriptions
POST /subscriptions/{subscriptionsId}/reauthorize
PATCH /subscriptions/{id}
DELETE /subscriptions/{subscription-id}
Methods
GET /me/joinedTeams/getOpenShifts
GET /me/joinedTeams/getShifts
GET /me/joinedTeams/getTimesOff
GET /subscriptions
GET /subscriptions/{id}
GET /subscriptions/getVapidPublicKey
GET /team/{teamId}/schedule/shiftsRoleDefinitions/{roleId}
GET /teams/{id}/schedule/openShiftChangeRequests
GET /teams/{id}/schedule/openShiftChangeRequests/{openShiftsChangeRequestId}
GET /teams/{id}/schedule/openShifts
GET /teams/{id}/schedule/openShifts/{openShiftId}
GET /teams/{teamId}/schedule
GET /teams/{teamId}/schedule/offerShiftRequests/{offerShiftRequestId}
GET /teams/{teamId}/schedule/schedulingGroups
GET /teams/{teamId}/schedule/schedulingGroups/{schedulingGroupId}
GET /teams/{teamId}/schedule/shifts
GET /teams/{teamId}/schedule/shifts/{shiftId}
GET /teams/{teamId}/schedule/swapShiftsChangeRequests
GET /teams/{teamId}/schedule/timeCards
GET /teams/{teamId}/schedule/timeCards/{timeCardId}
GET /teams/{teamId}/schedule/timeOffReasons
GET /teams/{teamId}/schedule/timeOffReasons/{timeOffReasonId}
GET /teams/{teamId}/schedule/timeOffRequests
GET /teams/{teamId}/schedule/timeOffRequests/{timeOffRequestId}
GET /teams/{teamId}/schedule/timesOff
GET /teams/{teamId}/schedule/timesOff/{timeOffId}
GET /teams/{teamsId}/schedule/dayNotes
GET /teams/{teamsId}/schedule/dayNotes/{dayNoteId}
GET /users/{id | user-principal-name}/joinedTeams/getOpenShifts
GET /users/{id | user-principal-name}/joinedTeams/getShifts
GET /users/{id | user-principal-name}/joinedTeams/getTimesOff
POST /subscriptions
POST /subscriptions/{subscriptionsId}/reauthorize
PATCH /subscriptions/{id}
DELETE /subscriptions/{subscription-id}

Code Examples

C# / .NET SDK
// Install: dotnet add package Microsoft.Graph
// Install: dotnet add package Azure.Identity
using Microsoft.Graph;
using Azure.Identity;

// Delegated permissions - interactive user sign-in
var scopes = new[] { "Schedule.Read.All" };
var options = new InteractiveBrowserCredentialOptions
{
    ClientId = "YOUR_CLIENT_ID",
    TenantId = "YOUR_TENANT_ID",
    RedirectUri = new Uri("http://localhost")
};
var credential = new InteractiveBrowserCredential(options);
var graphClient = new GraphServiceClient(credential, scopes);

// Example: GET /me
var result = await graphClient.Me.GetAsync();
Console.WriteLine($"User: {result?.DisplayName}");

// Application permissions - daemon/service app
var tenantId = "YOUR_TENANT_ID";
var clientId = "YOUR_CLIENT_ID";
var clientSecret = "YOUR_CLIENT_SECRET";

var credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
var graphClient = new GraphServiceClient(credential);

// Example: GET /users/{user-id}
var users = await graphClient.Users.GetAsync();
foreach (var user in users?.Value ?? [])
{
    Console.WriteLine($"User: {user.DisplayName}");
}
JavaScript / TypeScript
// npm install @azure/msal-browser @microsoft/microsoft-graph-client
import { PublicClientApplication } from "@azure/msal-browser";
import { Client } from "@microsoft/microsoft-graph-client";
import { AuthCodeMSALBrowserAuthenticationProvider } from 
    "@microsoft/microsoft-graph-client/authProviders/authCodeMsalBrowser";

const msalConfig = {
    auth: {
        clientId: "YOUR_CLIENT_ID",
        authority: "https://login.microsoftonline.com/YOUR_TENANT_ID"
    }
};

const pca = new PublicClientApplication(msalConfig);
await pca.initialize();

// Delegated: Login with required scope
const loginResponse = await pca.loginPopup({
    scopes: ["Schedule.Read.All"]
});

const authProvider = new AuthCodeMSALBrowserAuthenticationProvider(pca, {
    account: loginResponse.account,
    scopes: ["Schedule.Read.All"],
    interactionType: "popup"
});

const graphClient = Client.initWithMiddleware({ authProvider });

// Example: GET /me
const result = await graphClient.api("/me").get();
console.log(result);

// Application: Use client credentials (Node.js backend only)
// npm install @azure/identity @microsoft/microsoft-graph-client
import { ClientSecretCredential } from "@azure/identity";
import { TokenCredentialAuthenticationProvider } from 
    "@microsoft/microsoft-graph-client/authProviders/azureTokenCredentials";

const credential = new ClientSecretCredential(
    "YOUR_TENANT_ID",
    "YOUR_CLIENT_ID", 
    "YOUR_CLIENT_SECRET"
);

const authProvider = new TokenCredentialAuthenticationProvider(credential, {
    scopes: ["https://graph.microsoft.com/.default"]
});

const graphClient = Client.initWithMiddleware({ authProvider });
const result = await graphClient.api("/users").get();
console.log(result);
PowerShell
# Install Microsoft Graph PowerShell module
Install-Module Microsoft.Graph -Scope CurrentUser

# Delegated access - interactive sign-in
Connect-MgGraph -Scopes "Schedule.Read.All"

# Verify connection
Get-MgContext | Select-Object Account, TenantId, Scopes

# Example: GET /me
$result = Invoke-MgGraphRequest -Method GET -Uri "https://graph.microsoft.com/v1.0/me"
$result | ConvertTo-Json -Depth 5

# Application access with certificate
$params = @{
    ClientId = "YOUR_CLIENT_ID"
    TenantId = "YOUR_TENANT_ID"
    CertificateThumbprint = "YOUR_CERT_THUMBPRINT"
}
Connect-MgGraph @params

# Or with client secret (not recommended for production)
# Connect-MgGraph -ClientSecretCredential $credential

# Example: GET /users
$result = Invoke-MgGraphRequest -Method GET -Uri "https://graph.microsoft.com/v1.0/users"
$result | ConvertTo-Json -Depth 5

# Always disconnect when done
Disconnect-MgGraph
Python
# pip install msgraph-sdk azure-identity
from azure.identity import InteractiveBrowserCredential, ClientSecretCredential
from msgraph import GraphServiceClient
import asyncio

# Delegated permissions - interactive browser sign-in
credential = InteractiveBrowserCredential(
    client_id="YOUR_CLIENT_ID",
    tenant_id="YOUR_TENANT_ID"
)
scopes = ["Schedule.Read.All"]
client = GraphServiceClient(credential, scopes)

async def get_data():
    # Example: GET /me
    result = await client.me.get()
    print(f"User: {result.display_name}")
    return result

asyncio.run(get_data())

# Application permissions - client credentials
credential = ClientSecretCredential(
    tenant_id="YOUR_TENANT_ID",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET"
)
scopes = ["https://graph.microsoft.com/.default"]
client = GraphServiceClient(credential, scopes)

async def get_users():
    # Example: GET /users
    result = await client.users.get()
    for user in result.value:
        print(f"User: {user.display_name}")
    return result

asyncio.run(get_users())

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Application permissions or Delegated permissions and search for Schedule.Read.All

4

Grant Admin Consent

Application permissions always require admin consent. Click "Grant admin consent" in the Azure portal.