CDN
Get contents
CMSで公開したコンテンツ一覧を取得します。
APIエンドポイント
{subdomain} にはプロジェクト固有の値が入ります。KARTE管理画面の「CMS設定」>「APIエンドポイント」で確認できます。
⚠️ 注意: Base URLの{subdomain}を編集しても、API Requestのコード例には反映されません。Shell/Node/Ruby等のExampleは反映されるのでそちらを使うか、API Requestを利用する場合はdevKarte.server()で実際のエンドポイントURLを指定してください。
Required Scope
APIの実行に必要なScopeです。
beta.cdn.cms.content.list
Required Role
管理画面でScopeを追加する際に必要な権限です。
Craft > Craft 設定の編集
レート制限
プロジェクトごとに、1秒あたり80回まで(キャッシュされていないリクエストのみ)です。CDN API・Preview API は別々に数え、一覧取得と単体取得は合算します。超えると 429 Too Many Requests を返します。Retry-After ヘッダーの秒数だけ待ってから再度リクエストしてください。
get/beta/cms/content/list
Request
- Base URLhttps://your-project-subdomain.cdn-api.karte.io
- URLhttps://your-project-subdomain.cdn-api.karte.io/beta/cms/content/list
- AuthHTTP bearer
Query parameters
modelIdstring required
取得するコンテンツが所属するモデルのIDを指定します。
Example:6347f05d5d18d4536af5f336
{
"slug": {
"$eq": "post-1"
}
}selectstring[]
取得するコンテンツが持つプロパティを指定できます。複数の値を指定できます。idは必ず含まれます。
[ "title", "slug" ]
orderstring[]
取得するコンテンツの順番を指定できます。複数の値を指定できます。降順にしたい場合は「-」をつけます。
[ "-sys.createdAt" ]
skipinteger nullable
何件のコンテンツをスキップするか指定できます。
limitinteger
最大何個のコンテンツを取得するか指定できます。
Example:100
Headers
x-karte-apistring
今後利用する可能性のある予約語です。現在は設定不要です。
Response
Success Response
Example response
{
"limit": 100,
"total": 246,
"items": [
{
"id": "6109f05d5d18d6006af5f385",
"sys": {
"createdAt": "2025-04-06T00:18:26.810Z",
"updatedAt": "2025-04-06T08:39:45.628Z",
"modelId": "6347f05d5d18d4536af5f336",
"customOrder": 15,
"raw": {
"createdAt": "2025-04-05T05:29:09.614Z",
"updatedAt": "2025-04-06T08:39:45.628Z",
"firstPublishedAt": "2025-04-06T00:18:26.810Z",
"publishedAt": "2025-04-06T08:39:45.628Z"
}
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.