docs/interfaces/management.Management.ListUsersRequestParameters.html
{ * page: 1, * per_page: 1, * include_totals: true, * sort: "sort", * connection: "connection", * fields: "fields", * include_fields: true, * q: "q", * search_engine: "v1", * primary_order: true * }Copy
interface ListUsersRequestParameters {
page?: number | null;
per_page?: number | null;
include_totals?: boolean | null;
sort?: string | null;
connection?: string | null;
fields?: string | null;
include_fields?: boolean | null;
q?: string | null;
search_engine?: Management.SearchEngineVersionsEnum | null;
primary_order?: boolean | null;
}
page?per_page?include_totals?sort?connection?fields?include_fields?q?search_engine?primary_order?
Optionalpagepage?: number | null
Page index of the results to return. First page is 0.
Optionalper_pageper_page?: number | null
Number of results per page.
Optionalinclude_totalsinclude_totals?: boolean | null
Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
Optionalsortsort?: string | null
Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at:1
Optionalconnectionconnection?: string | null
Connection filter. Only applies when using search_engine=v1. To filter by connection with search_engine=v2|v3, use q=identities.connection:"connection_name"
Optionalfieldsfields?: string | null
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.
Optionalinclude_fieldsinclude_fields?: boolean | null
Whether specified fields are to be included (true) or excluded (false).
Optionalqq?: string | null
Query in Lucene query string syntax. Some query types cannot be used on metadata fields, for details see Searchable Fields.
Optionalsearch_enginesearch_engine?: Management.SearchEngineVersionsEnum | null
The version of the search engine
Optionalprimary_orderprimary_order?: boolean | null
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.
Member Visibility
ThemeOSLightDark
Properties pageper_pageinclude_totalssortconnectionfieldsinclude_fieldsqsearch_engineprimary_order