List users

GET/api/security/users/?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.
order	query	string	-	A comma-separated list of the field Ids to order the results by. Prefix field Id with - for descending order.
q	query	string	-	A simple query to perform a 'contains' search over key properties.
zenql	query	string	-	ZenQL query to select the users returned in the listing

Responses

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

Examples

Get the first page of 5 users that contain the word tyler in their key properties.

HTTP

GET: /api/security/users?q=tyler&pageSize=5

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