List groups
Log in to add to favouritesGET/api/security/groups/?order={order}&q={q}&zenql={zenql}&pageIndex={pageIndex}&pageSize={pageSize}
Parameters
| Name | Parameter type | Type | Format | Description |
|---|---|---|---|---|
| pageIndex | query | number | integer | The index of the page. |
| pageSize | query | number | integer | The number of results per page. The default is 25. |
| q | query | string | - | A simple query to perform a 'contains' search over key properties. |
| order | query | string | - | A comma-separated list of the field Ids to order the results by. Prefix field Id with - for descending order. |
| zenql | query | string | - | ZenQL query to select the groups returned in the listing |
Responses
Examples
Get a list of groups with the name containing the word 'mayhem'
GET: /api/security/groups?q=mayhemRemarks
Permissions
Member of System Administrators.