---
title: "Get preview contents"
method: GET
path: "/beta/cms/content/preview/list"
tags: ["Preview"]
---

# Get preview contents

`GET /beta/cms/content/preview/list`

## Request

- Base URL: `https://your-project-subdomain.cdn-api.karte.io`
- URL: `https://your-project-subdomain.cdn-api.karte.io/beta/cms/content/preview/list`
- Auth: HTTP bearer

プレビュー用のコンテンツ一覧を取得します。

  #### 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.preview.list
  ```

  #### Required Role
  管理画面でScopeを追加する際に必要な権限です。
  ```
  Craft > Craft 設定の編集
  ```

  #### レート制限
  プロジェクトごとに、1秒あたり20回までです。CDN API・Preview API は別々に数え、一覧取得と単体取得は合算します。超えると `429 Too Many Requests` を返します。`Retry-After` ヘッダーの秒数だけ待ってから再度リクエストしてください。

## Query parameters

- `modelId` string, required: 取得するコンテンツが所属するモデルのIDを指定します。
- `filter` object: 取得するコンテンツの条件を指定できます。未入力のフィールドは型に応じた空値（空文字・0・false・null）として保存されるため、$ne は未入力のコンテンツにもマッチします。
  - `id` object
    - `$eq` string
    - `$ne` string
    - `$gt` string
    - `$gte` string
    - `$lt` string
    - `$lte` string
    - `$in` string[]
  - `sys.createdAt` object
    - `$eq` string
    - `$ne` string
    - `$gt` string
    - `$gte` string
    - `$lt` string
    - `$lte` string
    - `$in` string[]
  - `sys.updatedAt` object
    - `$eq` string
    - `$ne` string
    - `$gt` string
    - `$gte` string
    - `$lt` string
    - `$lte` string
    - `$in` string[]
  - `sys.modelId` object
    - `$eq` string
    - `$ne` string
    - `$gt` string
    - `$gte` string
    - `$lt` string
    - `$lte` string
    - `$in` string[]
  - `sys.customOrder` object
    - `$eq` number, nullable
    - `$ne` number, nullable
    - `$gt` number, nullable
    - `$gte` number, nullable
    - `$lt` number, nullable
    - `$lte` number, nullable
    - `$in` number[]
  - `sys.raw.createdAt` object
    - `$eq` string
    - `$ne` string
    - `$gt` string
    - `$gte` string
    - `$lt` string
    - `$lte` string
    - `$in` string[]
  - `sys.raw.updatedAt` object
    - `$eq` string
    - `$ne` string
    - `$gt` string
    - `$gte` string
    - `$lt` string
    - `$lte` string
    - `$in` string[]
  - `sys.raw.firstPublishedAt` object
    - `$eq` string
    - `$ne` string
    - `$gt` string
    - `$gte` string
    - `$lt` string
    - `$lte` string
    - `$in` string[]
  - `sys.raw.publishedAt` object
    - `$eq` string
    - `$ne` string
    - `$gt` string
    - `$gte` string
    - `$lt` string
    - `$lte` string
    - `$in` string[]
- `select` string[]: 取得するコンテンツが持つプロパティを指定できます。複数の値を指定できます。idは必ず含まれます。
- `order` string[]: 取得するコンテンツの順番を指定できます。複数の値を指定できます。降順にしたい場合は「-」をつけます。
- `skip` integer, nullable: 何件のコンテンツをスキップするか指定できます。
- `limit` integer: 最大何個のコンテンツを取得するか指定できます。

## Headers

- `x-karte-api` string: 今後利用する可能性のある予約語です。現在は設定不要です。

## Response `200`

Success Response

- object: コンテンツのコレクションをラッパーオブジェクトとして返します。
  - `skip` integer, required: 何件のコンテンツをスキップしているか表します。
  - `limit` integer, required: 最大何個のコンテンツを取得するか表します。
  - `total` integer, required: 条件に合致するコンテンツが何個あるか表します。
  - `items` object[], required: 取得したコンテンツ情報が入ります。
    - `id` string, required: コンテンツのIDです。
    - `sys` object: システム側で自動で設定された情報が入ります。
      - `createdAt` string: コンテンツの作成日時です。
      - `updatedAt` string: コンテンツの更新日時です。
      - `modelId` string: コンテンツが所属するモデルのIDです。
      - `customOrder` integer: カスタム順序の値です。
      - `raw` object: システム情報の生データです。
        - `createdAt` string: コンテンツの作成日時（生データ）です。
        - `updatedAt` string: コンテンツの更新日時（生データ）です。
        - `firstPublishedAt` string, nullable: コンテンツの初回公開日時です。
        - `publishedAt` string, nullable: コンテンツの最新公開日時です。

## Other responses

- `429`: Too Many Requests
- `default`: unexpected error

---

[API](https://skmtc.dev/karte/apis/cms-preview.md) - [All operations](https://skmtc.dev/karte/apis/cms-preview/llms.txt) - [OpenAPI document](https://skmtc.dev/karte/apis/cms-preview/revisions/c1fc498e136c?raw)