Interface PlaceUserQueryOptions

Mapping of available query paramters for the users index

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

Hierarchy

  • PlaceResourceQueryOptions
    • PlaceUserQueryOptions

Properties

_poll? authority_id? cache? fields? limit? offset? q?

Properties

Optional_poll

_poll?: boolean

Whether the request is a API poll request

Optionalauthority_id

authority_id?: string

Return only users on the given domain

Optionalcache

cache?: number

Number of milliseconds to cache the query response

Optionalfields

fields?: string

Comma seperated list of fields to apply the query to

Optionallimit

limit?: number

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

Optionaloffset

offset?: number

Offsets of the results to return. Max 10000

Optionalq

q?: string

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

Settings

Member Visibility

On This Page

Properties