HTTP - Management
Removed from your favourites
List groups
Created by c.neale, last modified by zengenti on 17 Jun 2022
Group resources can be retrieved as a paged list.
GET/api/security/groups/?order={order}&q={q}&pageIndex={pageIndex}&pageSize={pageSize}
Parameters
| Name | Parameter type | Type | Format | Description | Example |
|---|---|---|---|---|---|
| pageIndex | query | number | integer | The index of the page | |
| pageSize | query | number | integer | The number of results per page. The default is 25. | |
| order | query | string | A comma-separated list of the field Ids to order the results by. Prefix field Id with - for descending order. | -version.modified |
Example
Get a list of groups with the name containing the word 'mayhem'
GET: /api/security/groups?q=mayhemRemarks
Permissions
Member of System Administrators.
Responses
| HTTP status code | Reason | Model |
|---|---|---|
| 200 | Success | PagedList<Group> |
| 401 | Unauthorized | Error |
| 403 | Forbidden | Error |
| 500 | Internal server error | Error |