Interface PlaceGroupUserQueryOptions

Mapping of available query parameters for the group users index endpoint

interface PlaceGroupUserQueryOptions {
    _poll?: boolean;
    cache?: number;
    fields?: string;
    group_id?: string;
    limit?: number;
    offset?: number;
    q?: string;
    ref?: string;
    user_id?: string;
}

Hierarchy (View Summary)

Properties

_poll? cache? fields? group_id? limit? offset? q? ref? user_id?

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.

Optionalgroup_id

group_id?: string

ID of the group to filter memberships by

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

Optionaluser_id

user_id?: string

ID of the user to filter memberships by. Use me for the current user.

Settings

Member Visibility

On This Page

Properties