REST API のパラメータ

REST API では API パラメータで結果のフィルター、ソート、ページネーション、表示フィールドやポピュレートするリレーションの指定ができます。さらに、下書きと公開の状態やロケールなど、オプション機能に関するパラメータも使えます。

利用できる API パラメータは次のとおりです。

パラメータ	型	説明
filters	Object	レスポンスをフィルター
locale	String	ロケールを指定
status	String	下書きと公開の状態を指定
populate	String or Object	リレーション、コンポーネント、ダイナミックゾーンをポピュレート
fields	Array	表示するフィールドのみを選択
sort	String or Array	レスポンスをソート
pagination	Object	エントリをページング

Note

パラメータ内の長い角括弧エンコードのリスト（例: populate や fields）は、strapi::query の arrayLimit により制限されます。ポピュレート も参照してください。

クエリパラメータは LHS bracket 構文（角括弧 [] でエンコード）を使います。

Tip

多くの REST API パラメータを組み合わせるとクエリ URL が長く複雑になりがちです。
👉 Strapi の インタラクティブなクエリビルダー で URL を組み立てると便利です。 🤗