List Compliance User Groups

List compliance user groups matching a set of filters. Released in 1.55.3

Get all groups of group type.

GETyourpodURL.symphony.com/pod/v2/admin/usergroups

Query parameters

Header parameters

Response

200400401403500

Success

Body

application/json

dataarray of UserGroupResponse (object)

paginationPagination (object)

Request

JavaScriptCurlPython

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

Response

200400401403500

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "area": "text",
      "description": "text",
      "type": "text",
      "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"
  }
}

🚧 Scoping groups

Scoping groups are used to manage the set of users and conversations that Compliance Officers or Super Compliance Officers have access to.

📘 Note

A compliance group must exactly match all of the specified query parameters to be included in the results.

🚧 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.