跳到主要内容

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:

OperatorTypeDescription
populateString or ObjectPopulate relations, components, or dynamic zones
fieldsArraySelect only specific fields to display
filtersObjectFilter the response
localeStringSelect a locale
statusStringSelect the Draft & Publish status
sortString or ArraySort the response
paginationObjectPage through entries

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. 🤗