StrapiQueryParams

Upgather SDK

---

Upgather SDK / StrapiQueryParams

Interface: StrapiQueryParams

Defined in: lib/services/StrapiService.ts:72

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[]

Defined in: lib/services/StrapiService.ts:74

---

filters?

optional filters: Record<string, unknown>

Defined in: lib/services/StrapiService.ts:75

---

locale?

optional locale: string

Defined in: lib/services/StrapiService.ts:76

---

pagination?

optional pagination: object

Defined in: lib/services/StrapiService.ts:79

Index Signature

[key: string]: undefined | number

page?

optional page: number

pageSize?

optional pageSize: number

---

populate?

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

Defined in: lib/services/StrapiService.ts:73

---

sort?

optional sort: string | string[]

Defined in: lib/services/StrapiService.ts:78

---

status?

optional status: string

Defined in: lib/services/StrapiService.ts:77