Interface IListRequestOptions

interface IListRequestOptions {
    ids?: number[];
    locationIds?: number[];
    order?: "asc" | "desc";
    page?: number;
    perPage?: number;
    search?: string;
    showHidden?: boolean;
}

Hierarchy (view full)

Properties

ids? locationIds? order? page? perPage? search? showHidden?

Properties

Optionalids

ids?: number[]

A list of the ids of specific entities to return.

OptionallocationIds

locationIds?: number[]

Whether to search within specific locations

Optionalorder

order?: "asc" | "desc"

Whether the entities should be returned in ascending or descending order.

Optionalpage

page?: number

The page of entities to return. Defaults to the first page if no value is provided. This value is one-based.

OptionalperPage

perPage?: number

The number of entities to return per page. The maximum value is 200.

Optionalsearch

search?: string

A search string to filter the returned entities by.

OptionalshowHidden

showHidden?: boolean

Whether or not hidden entities should be returned. Defaults to false.

Settings

Member Visibility

On This Page

Properties