List groups

Page last updated 29 December 2023

GET/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

HTTP status code	Reason	Model
200	Success	Group
401	Unauthorized	Error
403	Forbidden	Error
500	Internal server error	Error

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