Microsoft Graph Employee Experience is a set of APIs that let developers integrate and extend Microsoft Viva capabilities across Microsoft 365. It focuses especially on learning and growth scenarios: you can connect external learning providers, synchronize course catalogs, create and manage learning assignments, and track users’ course activities—all while honoring Microsoft 365 security, privacy, and consent.
openapi: 3.1.0
info:
title: Microsoft Graph Employeeexperience
description: Needs a description.
paths:
/employeeExperience:
description: Provides operations to manage the employeeExperience singleton.
get:
tags:
- employeeExperience.employeeExperience
summary: Microsoft Graph Get employeeExperience
operationId: employeeExperience.employeeExperience.GetEmployeeExperience
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.employeeExperience'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- employeeExperience.employeeExperience
summary: Microsoft Graph Update employeeExperience
operationId: employeeExperience.employeeExperience.UpdateEmployeeExperience
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.employeeExperience'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.employeeExperience'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/employeeExperience/communities:
description: >-
Provides operations to manage the communities property of the
microsoft.graph.employeeExperience entity.
get:
tags:
- employeeExperience.community
summary: Microsoft Graph List communities
description: Get a list of the Viva Engage community objects and their properties.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/employeeexperience-list-communities?view=graph-rest-1.0
operationId: employeeExperience.ListCommunities
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.communityCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- employeeExperience.community
summary: Microsoft Graph Create community
description: Create a new community in Viva Engage.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/employeeexperience-post-communities?view=graph-rest-1.0
operationId: employeeExperience.CreateCommunities
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.community'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.community'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/employeeExperience/communities/{community-id}:
description: >-
Provides operations to manage the communities property of the
microsoft.graph.employeeExperience entity.
get:
tags:
- employeeExperience.community
summary: Microsoft Graph Get community
description: Read the properties and relationships of a community object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/community-get?view=graph-rest-1.0
operationId: employeeExperience.GetCommunities
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.community'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- employeeExperience.community
summary: Microsoft Graph Update community
description: Update the properties of an existing Viva Engage community.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/community-update?view=graph-rest-1.0
operationId: employeeExperience.UpdateCommunities
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.community'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.community'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- employeeExperience.community
summary: Microsoft Graph Delete community
description: >-
Delete a Viva Engage community along with all associated Microsoft 365
content, including the connected Microsoft 365 group, OneNote notebook,
and Planner plans. For more information, see What happens if I delete a
Viva Engage community connected to Microsoft 365 groups.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/community-delete?view=graph-rest-1.0
operationId: employeeExperience.DeleteCommunities
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: community-id
in: path
description: The unique identifier of community
required: true
schema:
type: string
x-ms-docs-key-type: community
/employeeExperience/communities/{community-id}/group:
description: >-
Provides operations to manage the group property of the
microsoft.graph.community entity.
get:
tags:
- employeeExperience.community
summary: Microsoft Graph Get group from employeeExperience
description: The Microsoft 365 group that manages the membership of this community.
operationId: employeeExperience.communities.GetGroup
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: community-id
in: path
description: The unique identifier of community
required: true
schema:
type: string
x-ms-docs-key-type: community
/employeeExperience/communities/{community-id}/group/serviceProvisioningErrors:
get:
tags:
- employeeExperience.community
summary: Microsoft Graph Get serviceProvisioningErrors property value
description: >-
Errors published by a federated service describing a nontransient,
service-specific error regarding the properties or link from a group
object. Supports $filter (eq, not, for isResolved and serviceInstance).
operationId: employeeExperience.communities.group.ListServiceProvisioningErrors
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.serviceProvisioningErrorCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: community-id
in: path
description: The unique identifier of community
required: true
schema:
type: string
x-ms-docs-key-type: community
/employeeExperience/communities/{community-id}/group/serviceProvisioningErrors/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- employeeExperience.community
summary: Microsoft Graph Get the number of the resource
operationId: >-
employeeExperience.communities.group.ServiceProvisioningErrors.GetCount-d8ef
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: community-id
in: path
description: The unique identifier of community
required: true
schema:
type: string
x-ms-docs-key-type: community
/employeeExperience/communities/{community-id}/owners:
description: >-
Provides operations to manage the owners property of the
microsoft.graph.community entity.
get:
tags:
- employeeExperience.community
summary: Microsoft Graph Get owners from employeeExperience
description: >-
The admins of the community. Limited to 100 users. If this property
isn't specified when you create the community, the calling user is
automatically assigned as the community owner.
operationId: employeeExperience.communities.ListOwners
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.userCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: community-id
in: path
description: The unique identifier of community
required: true
schema:
type: string
x-ms-docs-key-type: community
/employeeExperience/communities/{community-id}/owners/{user-id}:
description: >-
Provides operations to manage the owners property of the
microsoft.graph.community entity.
get:
tags:
- employeeExperience.community
summary: Microsoft Graph Get owners from employeeExperience
description: >-
The admins of the community. Limited to 100 users. If this property
isn't specified when you create the community, the calling user is
automatically assigned as the community owner.
operationId: employeeExperience.communities.GetOwners
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: community-id
in: path
description: The unique identifier of community
required: true
schema:
type: string
x-ms-docs-key-type: community
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- >-
/employeeExperience/communities/{community-id}/owners(userPrincipalName='{userPrincipalName}')
/employeeExperience/communities/{community-id}/owners/{user-id}/mailboxSettings:
get:
tags:
- employeeExperience.community
summary: Microsoft Graph Get mailboxSettings property value
description: >-
Settings for the primary mailbox of the signed-in user. You can get or
update settings for sending automatic replies to incoming messages,
locale, and time zone. Returned only on $select.
operationId: employeeExperience.communities.owners.GetMailboxSettings
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
patch:
tags:
- employeeExperience.community
summary: Microsoft Graph Update property mailboxSettings value.
operationId: employeeExperience.communities.owners.UpdateMailboxSettings
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: community-id
in: path
description: The unique identifier of community
required: true
schema:
type: string
x-ms-docs-key-type: community
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/employeeExperience/communities/{community-id}/owners/{user-id}/serviceProvisioningErrors:
get:
tags:
- employeeExperience.community
summary: Microsoft Graph Get serviceProvisioningErrors property value
description: >-
Errors published by a federated service describing a nontransient,
service-specific error regarding the properties or link from a user
object. Supports $filter (eq, not, for isResolved and serviceInstance).
operationId: employeeExperience.communities.owners.ListServiceProvisioningErrors
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.serviceProvisioningErrorCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: community-id
in: path
description: The unique identifier of community
required: true
schema:
type: string
x-ms-docs-key-type: community
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/employeeExperience/communities/{community-id}/owners/{user-id}/serviceProvisioningErrors/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- employeeExperience.community
summary: Microsoft Graph Get the number of the resource
operationId: >-
employeeExperience.communities.owners.ServiceProvisioningErrors.GetCount-6b17
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: community-id
in: path
description: The unique identifier of community
required: true
schema:
type: string
x-ms-docs-key-type: community
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/employeeExperience/communities/{community-id}/owners(userPrincipalName='{userPrincipalName}'):
description: >-
Provides operations to manage the owners property of the
microsoft.graph.community entity.
get:
tags:
- employeeExperience.community
summary: Microsoft Graph Get owners from employeeExperience
description: >-
The admins of the community. Limited to 100 users. If this property
isn't specified when you create the community, the calling user is
automatically assigned as the community owner.
operationId: employeeExperience.communities.owners.GetByUserPrincipalName
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: community-id
in: path
description: The unique identifier of community
required: true
schema:
type: string
x-ms-docs-key-type: community
- name: userPrincipalName
in: path
description: Alternate key of user
required: true
schema:
type: string
nullable: true
x-ms-docs-grouped-path:
- /employeeExperience/communities/{community-id}/owners/{user-id}
/employeeExperience/communities/{community-id}/owners/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- employeeExperience.community
summary: Microsoft Graph Get the number of the resource
operationId: employeeExperience.communities.owners.GetCount-1d4e
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: community-id
in: path
description: The unique identifier of community
required: true
schema:
type: string
x-ms-docs-key-type: community
/employeeExperience/communities/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- employeeExperience.community
summary: Microsoft Graph Get the number of the resource
operationId: employeeExperience.communities.GetCount-6b75
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
/employeeExperience/engagementAsyncOperations:
description: >-
Provides operations to manage the engagementAsyncOperations property of
the microsoft.graph.employeeExperience entity.
get:
tags:
- employeeExperience.engagementAsyncOperation
summary: Microsoft Graph Get engagementAsyncOperation
description: >-
Get an engagementAsyncOperation to track a long-running operation
request.
operationId: employeeExperience.ListEngagementAsyncOperations
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.engagementAsyncOperationCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- employeeExperience.engagementAsyncOperation
summary: >-
Microsoft Graph Create new navigation property to engagementAsyncOperations for employeeExperience
operationId: employeeExperience.CreateEngagementAsyncOperations
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementAsyncOperation'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementAsyncOperation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/employeeExperience/engagementAsyncOperations/{engagementAsyncOperation-id}:
description: >-
Provides operations to manage the engagementAsyncOperations property of
the microsoft.graph.employeeExperience entity.
get:
tags:
- employeeExperience.engagementAsyncOperation
summary: Microsoft Graph Get engagementAsyncOperation
description: >-
Get an engagementAsyncOperation to track a long-running operation
request.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/engagementasyncoperation-get?view=graph-rest-1.0
operationId: employeeExperience.GetEngagementAsyncOperations
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementAsyncOperation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- employeeExperience.engagementAsyncOperation
summary: >-
Microsoft Graph Update the navigation property engagementAsyncOperations in employeeExperience
operationId: employeeExperience.UpdateEngagementAsyncOperations
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementAsyncOperation'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementAsyncOperation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- employeeExperience.engagemen
# --- truncated at 32 KB (271 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/employeeexperience-openapi-original.yml