Get list of user groups
GET {{baseUrl}}/api/usergroups?nameBegins=TestUserGroup
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
nameBegins | string | Characters that the name must begin with | |
offset | null | Starting point within the collection of returned search results. Used to control paging behavior. |
Default value : 0 |
| limit | null | | Maximum number of items returned for a single search request. Used to control paging behavior. Use -1 for no limit (subject to Governing settings).
Default value : -1 |
| fields | null | | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-MSTR-AuthToken | string |