List users
Log in to add to favouritesGET/api/security/users/?order={order}&q={q}&zenql={zenql}&pageIndex={pageIndex}&pageSize={pageSize}
Parameters
| Name | Parameter type | Type | Format | Description | Example |
|---|---|---|---|---|---|
| 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. | -version.modified | |
| zenql | query | string | ZenQL query to select the users returned in the listing | firstname ~ test |
Responses
Examples
Get the first page of 5 users that contain the word tyler in their key properties.
1GET: /api/security/users?q=tyler&pageSize=5