Skip to main content
Browse Documentation

UserListOptions

Created by Alex Pop on 04 Aug 2020

A UserListOptions is a structure that is used to describe details for requesting users.

Name Type Format Description
q? string An simple query to perform a 'contains' search over users firstname, surname, username and email.
pageOptions? object PageOptions The page options.
order? string[] An array of properties to order the results by.
Prefix property with - for descending order.