WorkforceIntegration.Read.All | Graph Permissions

Permission Details

Application Permission

Read workforce integrations

Allows the app to read workforce integrations without a signed-in user.

Permission ID: f10b94b9-37d1-4c88-8b7e-bf75a1152d39

Delegated Permission

Read workforce integrations

Allows the app to read workforce integrations, to synchronize data from Microsoft Teams Shifts, on behalf of the signed-in user.

Permission ID: f1ccd5a7-6383-466a-8db8-1a656f7d06fa

Properties

Microsoft Graph v1.0 exact-category-docs

Properties is shown from stable Microsoft Graph v1.0 metadata.

Property	Type	Description
`apiVersion`	`Int32`Nullable	API version for the callback URL. Start with 1.
`createdDateTime`	`DateTimeOffset`Read-onlyNullable	The date and time at which this workforceIntegration was first created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from changeTrackedEntity.
`displayName`	`String`Nullable	Name of the workforce integration.
`eligibilityFilteringEnabledEntities`	`eligibilityFilteringEnabledEntities`	Support to view eligibility-filtered results. The possible values are: none, swapRequest, offerShiftRequest, unknownFutureValue, timeOffReason. Use the Prefer: include-unknown-enum-members request header to get the following members in this evolvable enum: timeOffReason.
`encryption`	`workforceIntegrationEncryption`	The workforce integration encryption resource.
`isActive`	`Boolean`Nullable	Indicates whether this workforce integration is currently active and available.
`supportedEntities`	`workforceIntegrationSupportedEntities`	The Shifts entities supported for synchronous change notifications. Shifts call back to the provided URL when client changes occur to the entities specified in this property. By default, no entities are supported for change notifications. The possible values are: none, shift, swapRequest, userShiftPreferences, openShift, openShiftRequest, offerShiftRequest, unknownFutureValue, timeCard, timeOffReason, timeOff, timeOffRequest. Use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: timeCard , timeOffReason , timeOff , timeOffRequest.
`url`	`String`Nullable	Workforce Integration URL for callbacks from the Shifts service.
`createdBy`	`object`	Identity of the creator of the entity.
`id`	`string`	The unique identifier for an entity. Read-only.
`lastModifiedBy`	`object`Read-only	Identity of the person who last modified the entity.
`lastModifiedDateTime`	`date-time`Read-onlyNullable	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

JSON Representation

Microsoft Graph v1.0 exact-category-docs

JSON representation is shown from stable Microsoft Graph v1.0 metadata.

JSON representation

{
  "@odata.type": "#microsoft.graph.workforceIntegration",
  "apiVersion": "Int32",
  "createdDateTime": "String (timestamp)",
  "displayName": "String",
  "eligibilityFilteringEnabledEntities": "String",
  "encryption": {
    "@odata.type": "microsoft.graph.workforceIntegrationEncryption"
  },
  "id": "String (identifier)",
  "isActive": "Boolean",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "supportedEntities": "String",
  "url": "String"
}

Relationships

Relationships metadata is not available for this permission mapping.

View resource documentation

Graph Methods

Delegated access App-only access

Exact Microsoft Learn match

Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/teamwork/workforceIntegrations`
GET `/teamwork/workforceIntegrations/{workforceIntegrationId}`

Exact Microsoft Learn match

Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/teamwork/workforceIntegrations`
GET `/teamwork/workforceIntegrations/{workforceIntegrationId}`

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Get-MgTeamworkWorkforceIntegration` /teamwork/workforceIntegrations List workforceIntegrations
`Get-MgTeamworkWorkforceIntegration` /teamwork/workforceIntegrations/{workforceIntegrationId} Get workforceIntegration

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Get-MgBetaTeamworkWorkforceIntegration` /teamwork/workforceIntegrations List workforceIntegrations
`Get-MgBetaTeamworkWorkforceIntegration` /teamwork/workforceIntegrations/{workforceIntegrationId} Get workforceIntegration

Code Examples

C# / .NET SDK

Get workforceIntegration

View official example on Microsoft Learn

// 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.Teamwork.WorkforceIntegrations["{workforceIntegration-id}"].GetAsync();

JavaScript

Get workforceIntegration

View official example on Microsoft Learn

const options = {
	authProvider,
};

const client = Client.init(options);

let workforceIntegration = await client.api('/teamwork/workforceIntegrations/{workforceintegrationid}')
	.get();

PowerShell

Get workforceIntegration

View official example on Microsoft Learn

Import-Module Microsoft.Graph.Teams

Get-MgTeamworkWorkforceIntegration -WorkforceIntegrationId $workforceIntegrationId

Python

Get workforceIntegration

View official example on Microsoft Learn

# 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.teamwork.workforce_integrations.by_workforce_integration_id('workforceIntegration-id').get()

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 WorkforceIntegration.Read.All

4

Grant Admin Consent

Application permissions always require admin consent.