Cookie control banner

We use cookies to ensure our website works properly, deliver personalised advertising, and collect usage statistics to help us improve the website. You may change your settings at any time or accept the default settings. For more information, please refer to our privacy policy.
Skip to main content
GET/api/security/groups/?order={order}&q={q}&zenql={zenql}&pageIndex={pageIndex}&pageSize={pageSize}

Parameters

NameParameter typeTypeFormatDescription
pageIndexquerynumberintegerThe index of the page.
pageSizequerynumberintegerThe number of results per page. The default is 25.
qquerystring-A simple query to perform a 'contains' search over key properties.
orderquerystring-A comma-separated list of the field Ids to order the results by. Prefix field Id with - for descending order.
zenqlquerystring-ZenQL query to select the groups returned in the listing

Responses

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

Examples

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

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

Remarks

Permissions

Member of System Administrators.

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.
New support request