コンテンツにスキップ
KARTE Craft Developer Portal

メソッド

CDN APIとPreview APIには、コンテンツ一覧を取得するメソッドと、1件のコンテンツを取得するメソッドがあります。CDN APIは公開済みのコンテンツを、Preview APIは下書きを含むコンテンツを取得します。

メソッド一覧

APIメソッドパススコープ
CDN APIコンテンツ一覧の取得/beta/cms/content/listbeta.cdn.cms.content.list
CDN APIコンテンツの取得/beta/cms/content/getbeta.cdn.cms.content.get
Preview APIコンテンツ一覧の取得/beta/cms/content/preview/listbeta.cdn.cms.content.preview.list
Preview APIコンテンツの取得/beta/cms/content/preview/getbeta.cdn.cms.content.preview.get

各メソッドのパラメータの詳細は、Craft Cross CMSのAPIリファレンスを参照してください。

コンテンツ一覧の取得

指定したモデルに所属するコンテンツの一覧を取得します。

主なパラメータは次のとおりです。

  • modelId: 取得するコンテンツが所属するモデルのID（必須）
  • filter: 取得するコンテンツの絞り込み条件
  • select: 取得するプロパティの指定
  • order: 並び順の指定
  • skip: スキップする件数
  • limit: 取得する最大件数

filter や select などの指定方法は、クエリのページを参照してください。

レスポンスの構造

レスポンスは、取得したコンテンツの配列を、ページネーション情報でラップしたオブジェクトです。

プロパティ概要
skipスキップした件数
limit取得する最大件数
total条件に合致するコンテンツの総数
items取得したコンテンツの配列

items の各要素は、コンテンツの id とシステム情報 sys、そしてモデルで定義したフィールドの値を持ちます。sys に含まれる情報は、コンテンツのページを参照してください。

{
  "skip": 0,
  "limit": 100,
  "total": 1,
  "items": [
    {
      "id": "xxxxxxxxxxxx",
      "sys": {
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "modelId": "yyyyyyyyyyyy",
        "customOrder": 1,
        "raw": {
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z",
          "firstPublishedAt": "2026-01-01T00:00:00.000Z",
          "publishedAt": "2026-01-01T00:00:00.000Z"
        }
      },
      "title": "最初の記事",
      "slug": "post-1"
    }
  ]
}

total は条件に合致するコンテンツの総数で、limit で指定する1回あたりの取得上限とは別の値です。総数が limit を超える場合は、skip をずらしながら複数回リクエストすることで、すべてのコンテンツを取得できます。

コンテンツの取得

modelId と contentId で指定した1件のコンテンツを取得します。

主なパラメータは次のとおりです。

  • modelId: 取得するコンテンツが所属するモデルのID（必須）
  • contentId: 取得するコンテンツのID（必須）
  • select: 取得するプロパティの指定

一覧の取得とは異なり、絞り込みや並び替えは行わないため、filter、order、skip、limit は指定できません。

レスポンスの構造

レスポンスは、コンテンツ1件分のオブジェクトです。一覧の取得における items の要素1つと同じ構造です。

{
  "id": "xxxxxxxxxxxx",
  "sys": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "modelId": "yyyyyyyyyyyy",
    "customOrder": 1,
    "raw": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "firstPublishedAt": "2026-01-01T00:00:00.000Z",
      "publishedAt": "2026-01-01T00:00:00.000Z"
    }
  },
  "title": "最初の記事",
  "slug": "post-1"
}

CDN APIとPreview APIのレスポンスの違い

CDN APIとPreview APIは、レスポンスの構造は同じですが、sys.createdAt と sys.updatedAt に入る値が異なります。CDN APIには公開に関する日時が、Preview APIには作成および保存の日時が入ります。詳細は、コンテンツのページを参照してください。