REST API parameters
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 |
|---|---|---|
sort | String or Array | Sort the response |
filters | Object | Filter the response |
populate | String or Object | Populate relations, components, or dynamic zones |
fields | Array | Select only specific fields to display |
pagination | Object | Page through entries |
publicationState | String | Select the Draft & Publish state Only accepts the following values:
|
locale | String or Array | Select one or multiple locales |
Query parameters use the LHS bracket syntax (i.e. they are encoded using square brackets [])
💡 Tip
A wide range of REST API parameters can be used and combined to query your content, which can result in long and complex query URLs.
👉 You can use Strapi's interactive query builder tool to build query URLs more conveniently. 🤗