Interface Parameters

interface Parameters {
    fields?: string[];
    filters?: Filters;
    locale?: string | string[];
    pagination?: Pagination;
    populate?: string | object;
    publicationState?: "default" | "live";
    sort?: string | string[];
}

Properties

fields? filters? locale? pagination? populate? publicationState? sort?

Properties

Optional fields

fields?: string[]

Link

https://docs.strapi.io/dev-docs/api/rest/populate-select#field-selection

Optional filters

filters?: Filters

By default, the filters can only be used from find endpoints generated by the Content-type Builder and the CLI.

Link

https://docs.strapi.io/dev-docs/api/rest/filters-locale-publication#filtering

Optional locale

locale?: string | string[]

Link

https://docs.strapi.io/dev-docs/api/rest/filters-locale-publication#locale

Optional pagination

pagination?: Pagination

Link

https://docs.strapi.io/dev-docs/api/rest/sort-pagination#pagination

Optional populate

populate?: string | object

Link

https://docs.strapi.io/dev-docs/api/rest/populate-select#population

Optional publicationState

publicationState?: "default" | "live"

Default

live

Link

https://docs.strapi.io/dev-docs/api/rest/filters-locale-publication#publication-state

Optional sort

sort?: string | string[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc