Interface ListUsersRequestParameters

Page index of the results to return. First page is 0.

Number of results per page.

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at:1

Connection filter. Only applies when using search_engine=v1. To filter by connection with search_engine=v2|v3, use q=identities.connection:"connection_name"

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

Whether specified fields are to be included (true) or excluded (false).

Query in Lucene query string syntax. Some query types cannot be used on metadata fields, for details see Searchable Fields.

The version of the search engine

If true (default), results are returned in a deterministic order. If false, results may be returned in a non-deterministic order, which can enhance performance for complex queries targeting a small number of users. Set to false only when consistent ordering and pagination is not required.