Interface PlaceGroupQueryOptions

Mapping of available query parameters for the groups index endpoint

interface PlaceGroupQueryOptions {
    _poll?: boolean;
    cache?: number;
    fields?: string;
    include_children_count?: boolean;
    limit?: number;
    offset?: number;
    parent_id?: string;
    q?: string;
    ref?: string;
}

Hierarchy (View Summary)

Properties

_poll? cache? fields? include_children_count? limit? offset? parent_id? q? ref?

Properties

Optional_poll

_poll?: boolean

Whether the request is a API poll request

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_children_count

include_children_count?: boolean

Whether groups should include a count of their children

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

Optionalparent_id

parent_id?: string

ID of the parent group to filter by. Use root for root-level groups.

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