List Memberships

List memberships of a compliance group. Released in 1.55.3

Get the list of users in this Group Type

GETyourpodURL.symphony.com/pod/v2/admin/usergroups/{groupId}/memberships

Path parameters

groupId*string

URL-Safe encoded Group ID

Query parameters

Header parameters

Response

200400401403404500

Success

Body

application/json

dataarray of UserGroupMembershipResponseData (object)

paginationPagination (object)

Request

JavaScriptCurlPython

const response = await fetch('yourpodURL.symphony.com/pod/v2/admin/usergroups/{groupId}/memberships', {
    method: 'GET',
    headers: {
      "sessionToken": "text"
    },
});
const data = await response.json();

Response

200400401403404500

{
  "data": [
    {
      "id": "text",
      "groupId": "text",
      "group": {
        "id": "text",
        "name": "text",
        "area": "text",
        "type": "text",
        "active": false
      },
      "user": {
        "id": 7215545058329,
        "username": "dpayet",
        "firstName": "Dimitri",
        "lastName": "Payet",
        "emailAddress": "[e-mail]"
      },
      "active": false
    }
  ],
  "pagination": {
    "cursors": {
      "before": "MTAxNTExOTQ1MjAwNzI5NDE=",
      "after": "NDMyNzQyODI3OTQw"
    },
    "previous": "https://tenantapi.d.isym.io/v1/tenantinfo?limit=25&before=MTAxNTExOTQ1MjAwNzI5NDE=",
    "next": "https://tenantapi.d.isym.io/v1/tenantinfo?limit=25&after=NDMyNzQyODI3OTQw"
  }
}

🚧 Roles and Privileges

Calling this endpoint requires the Scope Management role with the VIEW_ROLE_SCOPES entitleable action. See Bot Permissions for a list of roles and associated privileges.

📘 Note

limit query parameter: A query may return fewer than the value of limit due to filtering or service-side maximums. Do not depend on the number of results being fewer than the limit value to indicate your query reached the end of the list of data, use the absence of next instead as described in the following example: If you set limit to 10 and only 9 results are returned, there may be more data available, but one item was removed due to privacy filtering. Some maximums for limit may be enforced for performance reasons.

sort query parameter: if the name of the field is preceded by a "-", then the results will be returned in descending order, otherwise results will be returned in ascending order. For example, a sort param value of "-name" would return results sorted by the "name" field in descending order, while a value of "name" would return results sorted by the "name" field in ascending order. The fields available for sorting are "lastAddedDate" and "lastRemovedDate".