1. ヘルプ
  2. 機能
  3. コンテンツAPI(GET)

下書き中の記事を取得する方法は?

下書き中の記事を取得するには、以下の2つの方法があります。以下にてそれぞれ解説します。

  • draftKeyパラメータを利用する方法(主に単体記事向け)
  • APIキーに「下書き全取得」権限を設定する方法(主に複数記事向け)

draftKeyパラメータを利用する方法

主に、単体の下書き中の記事を取得するための方法です。

こちらの方法については、microCMS公式ドキュメントの「画面プレビュー」にて詳細が記載されていますので、そちらをご覧ください。

APIキーに「下書きの全取得」権限を設定する方法

主に、複数の下書き中の記事を取得するための方法です。

APIキー管理ページにおいて、各APIキーのリクエスト権限(GET/下書きの全取得/POST/PATCH/DELETE)で「下書きの全取得」にチェックを入れると、下書き中のステータスのコンテンツを含む形で取得することができます。


参考:APIキー(X-MICROCMS-API-KEY)

スクリーンショット 2023-04-10 15.13.34

「下書きの全取得」を設定するには同時に「GET」権限を付与することが必要です。