Skip to main content
Browse Documentation
HTTP - Management

List Users

Created by s.yearsley, last updated 24 Sep 2020

User resources can be retrieved as a paged list and ordered by either username.

GET/api/security/users/?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 the first page of 5 users that contain the word tyler in their key properties.

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

Responses

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