Skip to main content

StrapiQueryParams

Upgather SDK

Upgather SDK / StrapiQueryParams

Interface: StrapiQueryParams

Describes the shape of valid query parameters for the Strapi REST API.

Remarks​

This interface includes the common parameters available in Strapi v5:

  • populate: To populate relations or nested components.
  • fields: To select specific fields to return.
  • filters: To filter the results.
  • locale: To specify a locale.
  • status: To specify the publication status.
  • sort: To sort the returned data.
  • pagination: To control pagination (e.g. page, pageSize).

Additional parameters can also be provided.

Indexable​

[key: string]: unknown

Properties​

fields?​

optional fields: string | string[]

filters?​

optional filters: Record<string, unknown>

locale?​

optional locale: string

pagination?​

optional pagination: object

Index Signature​

[key: string]: undefined | number

page?​

optional page: number

pageSize?​

optional pageSize: number

populate?​

optional populate: string | Record<string, unknown> | string[]

sort?​

optional sort: string | string[]

status?​

optional status: string