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

Get a list of groups with the name containing the word 'mayhem'

HTTP

GET: /api/security/groups?q=mayhem

Permissions

Member of System Administrators.