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

Deprecated

Ignored by the server since PlaceOS moved search to PostgreSQL (PPT-2644)

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 10000

Optionaloffset

offset?: number

Offset of the results to return. Max 1000000

Optionalparent_id

parent_id?: string

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

Optionalq

q?: string

Free-text search filter. Words match as prefixes against the resource's searchable fields (PostgreSQL full-text search); all words must match.

Optionalref

ref?: string

Deprecated

Ignored by the server; pagination follows the Link header's offset

Settings

Member Visibility

On This Page

Properties