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

Deprecated

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

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 10000

Optionaloffset

offset?: number

Offset of the results to return. Max 1000000

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