# List Compliance User Groups

## GET /v2/admin/usergroups

> Get all groups of group type.

```json
{"openapi":"3.1.1","info":{"title":"Restricted Pod API","version":"20.17.1"},"servers":[{"url":"https://yourpodURL.symphony.com/pod"}],"paths":{"/v2/admin/usergroups":{"get":{"summary":"Get all groups of group type.","parameters":[{"schema":{"type":"string"},"name":"sessionToken","description":"Session authentication token.","in":"header","required":true},{"schema":{"type":"string"},"name":"type","in":"query","required":true},{"schema":{"type":"string"},"name":"area","in":"query"},{"schema":{"type":"string"},"name":"name","in":"query"},{"schema":{"type":"boolean"},"name":"active","in":"query"},{"schema":{"type":"string"},"name":"after","in":"query"},{"schema":{"type":"string"},"name":"before","in":"query"},{"schema":{"type":"string"},"name":"sort","in":"query"},{"schema":{"type":"integer"},"name":"limit","description":"Max number of records to return.","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupResponseList"}}}},"400":{"description":"Client error, see response body for further details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Session tokens invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden: Caller lacks necessary entitlement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Server error, see response body for further details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"UserGroupResponseList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupResponse"}},"pagination":{"type":"object","$ref":"#/components/schemas/Pagination"}}},"UserGroupResponse":{"description":"Group object response","type":"object","properties":{"id":{"description":"Group ID","type":"string"},"name":{"description":"Group name","type":"string"},"area":{"description":"An optional string attribute used for categorizing groups","type":"string"},"description":{"description":"Group description","type":"string"},"type":{"description":"Group type","type":"string"},"active":{"description":"Group status","type":"boolean"},"createdDate":{"description":"Date of group creation","type":"integer","format":"int64"},"modifiedDate":{"description":"Date of group last update","type":"integer","format":"int64"},"memberCount":{"description":"Number of group members","type":"integer","format":"int64"},"assigneeCount":{"description":"Number of group assignees","type":"integer","format":"int64"}}},"Pagination":{"type":"object","required":["cursors"],"properties":{"cursors":{"type":"object","required":["before"],"properties":{"before":{"type":"string","description":"This is the opaque url-safe string that points to the start of the page of data\nthat has been returned.\n"},"after":{"type":"string","description":"This is the opaque url-safe string that points to the end of the page of data\nthat has been returned.\n"}}},"previous":{"type":"string","description":"API endpoint that will return the previous page of data. If not included, this is\nthe first page of data.\n"},"next":{"type":"string","description":"API endpoint that will return the next page of data. If not included, this is the\nlast page of data. Due to how pagination works with visibility and privacy, it is\npossible that a page may be empty but contain a 'next' paging link. Stop paging when\nthe 'next' link no longer appears.\n"}}},"Error":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"}}}}}}
```

> #### 🚧 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](https://docs.developers.symphony.com/bots/overview-of-rest-api/bot-permissions) for a list of roles and associated privileges.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://rest-api.symphony.com/main/compliance-barrier-groups/compliance-user-groups/list-compliance-user-groups.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.