Skip to content

engagementrole-list-members.md

Latest commit

 

History

History
142 lines (108 loc) · 5 KB

engagementrole-list-members.md

File metadata and controls

142 lines (108 loc) · 5 KB
title List members
description Get a list of users with assigned roles in Viva Engage.
author richafnu
ms.date 03/27/2025
ms.localizationpriority medium
ms.subservice viva-engage
doc_type apiPageType

List members

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a list of users with assigned roles 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/{engagementRoleId}/members

Optional query parameters

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

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

Description HTTP request
Filter role members by user ID GET /employeeExperience/roles/{engagementRoleId}/members?$filter=userId eq 'e8d9f6a2-1c34-4b7a-9f11-2a4d8b7c9e01'
Include the total count of role members GET /employeeExperience/roles/{engagementRoleId}/members?$count=true
Get only the id and createdDateTime properties for a list of role members GET /employeeExperience/roles/{engagementRoleId}/members?$select=id,createdDateTime

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 engagementRoleMember objects in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/employeeExperience/roles/a40473a5-0fb4-a250-e029-f6fe33d07733/members

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.engagementRoleMember",
      "id": "a40473a5-0fb4-a250-e029-f6fe33d07733",
      "userId": "e8d9f6a2-1c34-4b7a-9f11-2a4d8b7c9e01",
      "createdDateTime": "2025-09-22T14:03:00Z"
    }
  ]
}