Skip to main content
Browse Documentation
HTTP - Management

List groups

Created by c.neale, last modified by r.saunders on 12 Feb 2021

Group resources can be retrieved as a paged list.

GET/api/security/groups/?order={order}&q={q}&pageIndex={pageIndex}&pageSize={pageSize}

Parameters

NameParameter typeTypeFormatDescriptionExample
pageIndexquerynumberintegerThe index of the page
pageSizequerynumberintegerThe number of results per page. The default is 25.
orderquerystringA 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=mayhem

Responses

HTTP status codeReasonModel
200SuccessPagedList<Group>
401UnauthorizedError
403ForbiddenError
500Internal server errorError