REST API parameters#
REST API parameters filter, sort, paginate, and select fields and relations in Strapi queries. Use filters, locale, populate, sort, and pagination to refine your content requests.
API parameters can be used with the REST API to filter, sort, and paginate results and to select fields and relations to populate. Additionally, specific parameters related to optional Strapi features can be used, like the publication state and locale of a content-type.
The following API parameters are available:
| Operator | Type | Description |
|---|---|---|
filters | Object | Filter the response |
locale | String | Select a locale |
status | String | Select the Draft & Publish status |
publicationFilter | String | Select documents by how their draft and published versions relate |
populate | String or Object | Populate relations, components, or dynamic zones |
fields | Array | Select only specific fields to display |
sort | String or Array | Sort the response |
pagination | Object | Page through entries |
Query parameters use the (i.e. they are encoded using square brackets []).