Skip to main content
GET/api/security/groups/?order={order}&q={q}&zenql={zenql}&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
zenqlquerystringZenQL query to select the groups returned in the listingname ~ test

Responses

HTTP status codeReasonModel
200SuccessGroup
401UnauthorizedError
403ForbiddenError
500Internal server errorError

Examples

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

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

Remarks

Still need help?

New support request