Interface PlaceUserQueryOptions

Mapping of available query parameters for the users index endpoint

interface PlaceUserQueryOptions {
    _poll?: boolean;
    authority_id?: string;
    cache?: number;
    fields?: string;
    include_deleted?: boolean;
    include_metadata?: boolean;
    limit?: number;
    offset?: number;
    q?: string;
    ref?: string;
}

Hierarchy (View Summary)

Properties

_poll? authority_id? cache? fields? include_deleted? include_metadata? limit? offset? q? ref?

Properties

Optional_poll

_poll?: boolean

Whether the request is a API poll request

Optionalauthority_id

authority_id?: string

Admin users can view other domains (ignored for other users)

Optionalcache

cache?: number

Number of milliseconds to cache the query response

Optionalfields

fields?: string

Comma separated list of fields to search. Accepts wildcard expressions and boost relevance scores using caret ^ operator.

Optionalinclude_deleted

include_deleted?: boolean

Include soft deleted users in the results

Optionalinclude_metadata

include_metadata?: boolean

Include user metadata in the response

Optionallimit

limit?: number

Number of results to return. Defaults to 20. Max 500

Optionaloffset

offset?: number

Deprecated

Use ref for pagination. Offset of the results to return. Max 10000

Optionalq

q?: string

Search filter supporting the following syntax https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html

Optionalref

ref?: string

Token for accessing the next page of results, provided in the Link header

Settings

Member Visibility

On This Page

Properties