Microsoft Graph: Viva employee experience
Viva Engage communities, Viva Learning providers and course activities, and other employee experience features. This listing is one area of Microsoft Graph,…
Productivity & workspace#openapi
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Viva Engage communities, Viva Learning providers and course activities, and other employee experience features.
This listing is one area of Microsoft Graph, the single REST API for Microsoft 365, Outlook, OneDrive, Teams and Microsoft Entra ID. It holds 73 of the area's requests, the most direct ones first, generated from Microsoft's own OpenAPI description of Graph v1.0. The other areas (mail, calendar, files, Teams, users and more) are listed separately on the Microsoft page.
Get an access token
- Sign in to the Microsoft Entra admin center and open App registrations > New registration. For a quick test, the Graph Explorer signs you in and shows a token without registering anything.
- Under API permissions, add the Microsoft Graph permissions this area needs, for example:
Community.ReadWrite.All,LearningContent.ReadWrite.All. Delegated permissions act as the signed-in user; application permissions act as the app itself and need an administrator's consent. - Under Certificates & secrets, create a client secret (keep it out of shared collections).
- Get a token from
https://login.microsoftonline.com/ /oauth2/v2.0/token: the authorization-code flow for a user, orgrant_type=client_credentialswithscope=https://graph.microsoft.com/.defaultfor an app. Send it asAuthorization: Bearer.
Using these requests
- Base URL:
https://graph.microsoft.com/v1.0./me/...paths act on the signed-in user; with an application token use/users/{id or userPrincipalName}/...instead. - Shape responses with OData query parameters:
$select(fields),$filter,$orderby,$top,$expandand$search(some need theConsistencyLevel: eventualheader). Long lists are paged: follow@odata.nextLink. - Combine up to 20 requests in one call with
POST /$batch.
Common errors
| Status | Code | What to do |
|---|---|---|
| 401 | InvalidAuthenticationToken | The token is missing, expired or for another resource: get a new one for https://graph.microsoft.com. |
| 403 | Authorization_RequestDenied / ErrorAccessDenied | Add the permission listed in the request's docs and grant consent. |
| 404 | ResourceNotFound / itemNotFound | Check the id; ids from another user or tenant are not found. |
| 429 | TooManyRequests | Throttled: wait the Retry-After seconds, then retry. |
Docs: Viva employee experience overview · Permissions reference · Throttling
Endpoints 73
Employee experience
- GETGet employee experience
/employeeExperience - PATCHUpdate employee experience
/employeeExperience - GETGet employee experience
/me/employeeExperience - DELETEDelete employee experience
/me/employeeExperience - PATCHUpdate employee experience
/me/employeeExperience - GETList engagement async operations
/employeeExperience/engagementAsyncOperationsGet an engagementAsyncOperation to track a long-running operation request. - GETGet employee experience
/employeeExperience/learningCourseActivities(externalcourseActivityId=':externalcourseActivityId')Get the specified learningCourseActivity object using either an ID or an externalCourseActivityId of the learning provider, or a courseActivityId of a user. - DELETEDelete employee experience
/employeeExperience/learningCourseActivities(externalcourseActivityId=':externalcourseActivityId') - PATCHUpdate employee experience
/employeeExperience/learningCourseActivities(externalcourseActivityId=':externalcourseActivityId') - GETGet engagement async operation
/employeeExperience/engagementAsyncOperations/:engagementAsyncOperation-idGet an engagementAsyncOperation to track a long-running operation request. - GETGet employee experience
/me/employeeExperience/learningCourseActivities(externalcourseActivityId=':externalcourseActivityId')
Employee experience: roles
- GETList roles
/employeeExperience/rolesGet a list of all the roles that can be assigned in Viva Engage. - GETGet role
/employeeExperience/roles/:engagementRole-idA collection of roles in Viva Engage. - GETList members
/employeeExperience/roles/:engagementRole-id/membersGet a list of users with assigned roles in Viva Engage. - POSTCreate member
/employeeExperience/roles/:engagementRole-id/membersCreate a new engagementRoleMember object that assigns a Viva Engage role to a user. - GETGet member
/employeeExperience/roles/:engagementRole-id/members/:engagementRoleMember-idUsers that have this role assigned. - DELETEDelete member
/employeeExperience/roles/:engagementRole-id/members/:engagementRoleMember-idDelete a Viva Engage role from a user. - GETGet user
/employeeExperience/roles/:engagementRole-id/members/:engagementRoleMember-id/userThe user who has this role assigned. - GETGet mailbox settings
/employeeExperience/roles/:engagementRole-id/members/:engagementRoleMember-id/user/mailboxSettingsSettings 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… - PATCHUpdate mailbox settings
/employeeExperience/roles/:engagementRole-id/members/:engagementRoleMember-id/user/mailboxSettings - GETList service provisioning errors
/employeeExperience/roles/:engagementRole-id/members/:engagementRoleMember-id/user/serviceProvisioningErrorsErrors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports…
Employee experience: communities
- GETList communities
/employeeExperience/communitiesGet a list of the Viva Engage community objects and their properties. - POSTCreate community
/employeeExperience/communitiesCreate a new community in Viva Engage. - GETGet community
/employeeExperience/communities/:community-idRead the properties and relationships of a community object. - DELETEDelete community
/employeeExperience/communities/:community-idDelete a Viva Engage community along with all associated Microsoft 365 content, including the connected Microsoft 365 group, OneNote notebook, and Planner… - PATCHUpdate community
/employeeExperience/communities/:community-idUpdate the properties of an existing Viva Engage community. - GETGet group
/employeeExperience/communities/:community-id/groupThe Microsoft 365 group that manages the membership of this community. - GETList owners
/employeeExperience/communities/:community-id/ownersThe 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… - GETGet community
/employeeExperience/communities/:community-id/owners(userPrincipalName=':userPrincipalName')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… - GETGet owner
/employeeExperience/communities/:community-id/owners/:user-idThe 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… - GETList service provisioning errors
/employeeExperience/communities/:community-id/group/serviceProvisioningErrorsErrors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports… - GETGet mailbox settings
/employeeExperience/communities/:community-id/owners/:user-id/mailboxSettingsSettings 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… - PATCHUpdate mailbox settings
/employeeExperience/communities/:community-id/owners/:user-id/mailboxSettings - GETList service provisioning errors
/employeeExperience/communities/:community-id/owners/:user-id/serviceProvisioningErrorsErrors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports…
Employee experience: learning providers
- GETList learning providers
/employeeExperience/learningProvidersGet a list of the learningProvider resources registered in Viva Learning for a tenant. - POSTCreate learning provider
/employeeExperience/learningProvidersCreate a new learningProvider object and register it with Viva Learning using the specified display name and logos for different themes. - GETGet learning provider
/employeeExperience/learningProviders/:learningProvider-idRead the properties and relationships of a learningProvider object. - DELETEDelete learning provider
/employeeExperience/learningProviders/:learningProvider-idDelete a learningProvider resource and remove its registration in Viva Learning for a tenant. - PATCHUpdate learning provider
/employeeExperience/learningProviders/:learningProvider-idUpdate the properties of a learningProvider object. - GETList learning contents
/employeeExperience/learningProviders/:learningProvider-id/learningContentsGet a list of the learningContent resources and their properties. This list represents the metadata of the specified provider's content in Viva Learning. - POSTCreate learning content
/employeeExperience/learningProviders/:learningProvider-id/learningContents - GETList learning course activities
/employeeExperience/learningProviders/:learningProvider-id/learningCourseActivitiesGet the specified learningCourseActivity object using either an ID or an externalCourseActivityId of the learning provider, or a courseActivityId of a user. - POSTCreate learning course activity
/employeeExperience/learningProviders/:learningProvider-id/learningCourseActivitiesCreate a new learningCourseActivity object. A learning course activity can be one of two types: Assignment Self-initiated Use this method to create either… - GETGet learning provider
/employeeExperience/learningProviders/:learningProvider-id/learningContents(externalId=':externalId')Get the specified learningContent resource which represents the metadata of the specified provider's ingested content. - DELETEDelete learning provider
/employeeExperience/learningProviders/:learningProvider-id/learningContents(externalId=':externalId')Delete the specified learningContent resource that represents the metadata of the specified provider's ingested content. - PATCHUpdate learning provider
/employeeExperience/learningProviders/:learningProvider-id/learningContents(externalId=':externalId') - GETGet learning provider
/employeeExperience/learningProviders/:learningProvider-id/learningCourseActivities(externalcourseActivityId=':externalcourseActivityId') - DELETEDelete learning provider
/employeeExperience/learningProviders/:learningProvider-id/learningCourseActivities(externalcourseActivityId=':externalcourseActivityId')Delete a learningCourseActivity object using the course activity ID of either an assignment or a self-initiated activity. - PATCHUpdate learning provider
/employeeExperience/learningProviders/:learningProvider-id/learningCourseActivities(externalcourseActivityId=':externalcourseActivityId')Update the properties of a learningCourseActivity object. - GETGet learning content
/employeeExperience/learningProviders/:learningProvider-id/learningContents/:learningContent-idGet the specified learningContent resource which represents the metadata of the specified provider's ingested content. - DELETEDelete learning content
/employeeExperience/learningProviders/:learningProvider-id/learningContents/:learningContent-idDelete the specified learningContent resource that represents the metadata of the specified provider's ingested content. - PATCHUpdate learning content
/employeeExperience/learningProviders/:learningProvider-id/learningContents/:learningContent-id - GETGet learning course activity
/employeeExperience/learningProviders/:learningProvider-id/learningCourseActivities/:learningCourseActivity-id - DELETEDelete learning course activity
/employeeExperience/learningProviders/:learningProvider-id/learningCourseActivities/:learningCourseActivity-idDelete a learningCourseActivity object using the course activity ID of either an assignment or a self-initiated activity. - PATCHUpdate learning course activity
/employeeExperience/learningProviders/:learningProvider-id/learningCourseActivities/:learningCourseActivity-idUpdate the properties of a learningCourseActivity object.
Employee experience: learning course activities
- GETList learning course activities
/employeeExperience/learningCourseActivitiesGet the specified learningCourseActivity object using either an ID or an externalCourseActivityId of the learning provider, or a courseActivityId of a user. - POSTCreate learning course activity
/employeeExperience/learningCourseActivities - GETList learning course activities
/me/employeeExperience/learningCourseActivities - GETGet learning course activity
/employeeExperience/learningCourseActivities/:learningCourseActivity-idGet the specified learningCourseActivity object using either an ID or an externalCourseActivityId of the learning provider, or a courseActivityId of a user. - DELETEDelete learning course activity
/employeeExperience/learningCourseActivities/:learningCourseActivity-id - PATCHUpdate learning course activity
/employeeExperience/learningCourseActivities/:learningCourseActivity-id - GETGet learning course activity
/me/employeeExperience/learningCourseActivities/:learningCourseActivity-id
Employee experience: assigned roles
- GETList assigned roles
/me/employeeExperience/assignedRolesGet a list of all the roles assigned to a user in Viva Engage. - POSTCreate assigned role
/me/employeeExperience/assignedRoles - GETGet assigned role
/me/employeeExperience/assignedRoles/:engagementRole-idRepresents the collection of Viva Engage roles assigned to a user. - DELETEDelete assigned role
/me/employeeExperience/assignedRoles/:engagementRole-id - PATCHUpdate assigned role
/me/employeeExperience/assignedRoles/:engagementRole-id - GETList members
/me/employeeExperience/assignedRoles/:engagementRole-id/membersUsers that have this role assigned. - POSTCreate member
/me/employeeExperience/assignedRoles/:engagementRole-id/members - GETGet member
/me/employeeExperience/assignedRoles/:engagementRole-id/members/:engagementRoleMember-idUsers that have this role assigned. - DELETEDelete member
/me/employeeExperience/assignedRoles/:engagementRole-id/members/:engagementRoleMember-id - PATCHUpdate member
/me/employeeExperience/assignedRoles/:engagementRole-id/members/:engagementRoleMember-id - GETGet user
/me/employeeExperience/assignedRoles/:engagementRole-id/members/:engagementRoleMember-id/userThe user who has this role assigned.
API details
- Base URL
https://graph.microsoft.com/v1.0- Authentication
- OAuth 2.0 (authorization code, client credentials flows)
- Operations
- 73 operations on 39 pathsGET 39PATCH 14DELETE 12POST 8
- Main resources
- Employee experience: learning providers 21Employee experience: communities 13Employee experience 11Employee experience: assigned roles 11Employee experience: roles 10Employee experience: learning course activities 7
- Description format
- OpenAPI 3.0.4, API version
v1.0 - Links
- Documentation · OpenAPI document
How to test the Microsoft Graph: Viva employee experience in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Microsoft Graph: Viva employee experience collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code, client credentials flows). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get employee experience” (GET /employeeExperience), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Microsoft Graph: Viva employee experience?
Viva Engage communities, Viva Learning providers and course activities, and other employee experience features. This listing is one area of Microsoft Graph,… It is listed under Productivity & workspace and has 73 endpoints.
Who publishes the Microsoft Graph: Viva employee experience?
It is listed from Microsoft's public API description (an OpenAPI document), not published by Microsoft on Swastik Codes. Anyone who controls microsoft.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Microsoft Graph: Viva employee experience?
Requests go to https://graph.microsoft.com/v1.0. Endpoint paths are added to this base URL.
How do I authenticate with the Microsoft Graph: Viva employee experience?
With OAuth 2.0 (authorization code, client credentials flows).
How many endpoints does the Microsoft Graph: Viva employee experience have?
73 operations on 39 paths (39 GET, 14 PATCH, 12 DELETE, 8 POST). The largest groups are Employee experience: learning providers, Employee experience: communities, Employee experience, Employee experience: assigned roles.
Is forking the Microsoft Graph: Viva employee experience free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.