microCMS

チュートリアル
操作マニュアル
コンテンツAPI
マネジメントAPI（ベータ）
画像API
  • トップ
  • マネジメントAPI （ベータ）

GET /api/v1/contents/{endpoint}/{content_id}

最終更新日:2024年12月26日

リスト型APIにおいて、idで指定したコンテンツのメタ情報を取得できるAPIです。

リクエストヘッダー

X-MICROCMS-API-KEY

GET APIリクエストの際に必要な認証キーです。
マネジメントAPIのデフォルト権限で「コンテンツの取得 (一覧・詳細)」を有効にして、リクエストヘッダーに含めて送信してください。

cautionCaution

X-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「APIキー（APIの認証と権限管理）」をご覧ください。

レスポンスボディ

こちらがマネジメントAPIで取得したコンテンツ詳細のレスポンス例です。

{
    "id": "contentId",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "publishedAt": "2019-08-24T14:15:22Z",
    "revisedAt": "2019-08-24T14:15:22Z",
    "closedAt": null,
    "status": [
      "DRAFT"
    ],
    "customStatus": null,
    "draftKey": "draftKey",
    "createdBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
    "updatedBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
    "reservationTime": {
      "publishTime": "2019-08-24T14:15:22Z",
      "stopTime": "2019-08-24T14:15:22Z" 
    }
}

レスポンスには以下の項目が含まれます。

値

説明

id

コンテンツのIDが入ります。

createdAt

コンテンツを作成した日時が入ります。

updatedAt

コンテンツを更新した日時が入ります。

publishedAt

コンテンツを公開した日時が入ります。一度も公開したことがない場合はnullが入ります。

revisedAt

公開中のコンテンツが更新された日時が入ります。一度も公開したことがない場合はnullが入ります。

draftKey

管理画面で取得できる下書きキー（draftKey）が入ります。コンテンツの公開時、公開終了時はnullが入ります。

closedAt

公開終了の日時が入ります。一度も公開終了していない場合はnullが入ります。

status

コンテンツのステータスが入ります。DRAFT,PUBLISH,CLOSED,PUBLISH_AND_DRAFTのいずれかが入ります。

customStatus

設定したカスタムステータスの情報が入ります。未設定の場合はnullが入ります。詳細は「カスタムステータス」をご参照ください。

createdBy

コンテンツを作成したメンバーのIDが入ります。

updatedBy

コンテンツを最後に編集したメンバーのIDが入ります。

reservationTime

公開開始・公開停止予約に関する情報が入ります。

公開開始予約・公開停止予約のいずれも設定されていない場合はnullが入ります。

公開開始予約または公開停止予約のいずれかが設定されている場合は、publishTimeとstopTimeが含まれます。予約が設定されている方には日時が入り、設定されていない方にはnullが入ります。

例：公開開始予約のみ設定されている場合

"reservationTime": { "publishTime": "2024-12-25T06:45:00Z", "stopTime": null }

マネジメントAPIでのみ取得できる値

マネジメントAPI特有の値は以下のとおりです。これらの値はコンテンツAPIには含まれません。

  • closedAt
  • status
  • customStatus
  • createdBy
  • updatedBy
  • reservationTime

カスタムステータス

カスタムステータスが設定されたコンテンツでは以下のように customStatus がレスポンスに含まれます。

{
  "id": "contentId",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "publishedAt": "2019-08-24T14:15:22Z",
  "revisedAt": "2019-08-24T14:15:22Z",
  "status": [
    "PUBLISH"
  ],
  // このcustomStatusが新たに追加されます。
  // customStatusが未対応のプランや設定されていない場合はnullになります。
  "customStatus": [
    {
      "key": "USER_DEFINED_CUSTOM_STATUS_KEY123",
      "description": "ユーザが定義したカスタムステータスです。",
      "name": "カスタムステータスのテスト",
      "behaviour": "PUBLISH",
      "color": "#a20063",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "draftKey": "draftKey",
  "createdBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
  "updatedBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
  "reservationTime": {
    "publishTime": "2019-08-24T14:15:22Z",
    "stopTime": "2019-08-24T14:15:22Z"
  }
}


カスタムステータスについて詳しくは、以下ドキュメントをご覧ください。

カスタムステータス
https://document.microcms.io/manual/custom-status

目次