Interface GetUsersRequest

Hierarchy

  • GetUsersRequest

Properties

connection?: string

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

fields?: string

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.

include_fields?: boolean

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

include_totals?: boolean

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

page?: number

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

per_page?: number

Number of results per page. Paging is disabled if parameter not sent.

q?: string

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

search_engine?: GetUsersSearchEngineEnum

The version of the search engine

sort?: string

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