Skip to content

employeeexperience-list-roles.md

Latest commit

 

History

History
134 lines (102 loc) · 4.5 KB

employeeexperience-list-roles.md

File metadata and controls

134 lines (102 loc) · 4.5 KB
title List roles
description Get a list of all the roles that can be assigned in Viva Engage.
author richafnu
ms.date 09/22/2025
ms.localizationpriority medium
ms.subservice viva-engage
doc_type apiPageType

List roles

Namespace: microsoft.graph

Get a list of all the roles that can be assigned in Viva Engage.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

GET /employeeExperience/roles

Optional query parameters

This method supports the $filter (eq), $select, $top, and $count OData query parameters. For general information, see OData query parameters. Only the displayName and id properties support the $filter parameter.

The following table shows how you can use OData query parameters with this API.

Description HTTP request
Get the first 10 roles and include the count of total roles GET /employeeExperience/roles?$top=10&$count=true
Filter roles by the display name Network Admin GET /employeeExperience/roles?$filter=displayName eq 'Network Admin'
Get only the id and displayName properties for a list of roles GET /employeeExperience/roles?$select=id,displayName

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of engagementRole objects in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/v1.0/employeeExperience/roles

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#employeeExperience/roles",
  "value": [
    {
      "id": "ec759127-089f-4f91-8dfc-03a30b51cb38",
      "displayName": "Network Admin"
    },
    {
      "id": "966b8ec4-6457-4f22-bd3c-5a2520e98f4a",
      "displayName": "Verified Admin"
    },
    {
      "id": "77aa47ad-96fe-4ecc-8024-fd1ac5e28f17",
      "displayName": "Corporate Communicator"
    }
  ]
}