microCMS
ドキュメント
  • 料金プラン
  • ブログ
  • よくある質問
  • お問い合わせ
  • ログイン
  • 無料ではじめる
ナビゲーション
チュートリアル
Next.js
  • Next.jsとの連携
  • Getting Started(App Router)
  • チュートリアル(App Router)
  • Getting Started(Pages Router)
  • チュートリアル(Pages Router)
Astro
  • Astroとの連携
  • Getting Started
  • チュートリアル
Nuxt
  • Nuxtとの連携
  • Getting Started
  • チュートリアル
Gatsby
  • Gatsbyとの連携
  • Getting Started
  • チュートリアル
JavaScript
  • JavaScriptとの連携
  • Getting Started(ブラウザ)
  • Getting Started(サーバー)
PHP
  • PHPとの連携
  • Getting Started
Ruby
  • Rubyとの連携
  • Getting Started
Go
  • Goとの連携
  • Getting Started
操作マニュアル
  • はじめに
アカウントとログイン
  • アカウント登録
  • ログイン
  • メールアドレス認証をする
サービス
  • サービスの作成
  • サービス設定
  • テンプレート
  • サービスの削除
お支払い
  • 料金プランの変更
  • 決済方法の登録と変更
API
  • APIの作成・管理
  • API設定
  • APIスキーマのエクスポート/インポート
フィールド
  • テキストフィールド
  • テキストエリア
  • 画像
  • 複数画像
  • 日時
  • 真偽値
  • セレクトフィールド
  • コンテンツ参照
  • 複数コンテンツ参照
  • 数字
  • ファイル
  • カスタム
  • 繰り返し
  • 拡張フィールド
コンテンツ
  • コンテンツの作成
  • コンテンツの編集
  • コンテンツ管理
  • ビュー
  • コンテンツのステータス
  • カスタムステータス
  • コンテンツIDの設定
  • コンテンツに自動付与される値
  • コンテンツのCSVエクスポート
  • コンテンツのCSVインポート
  • APIプレビュー
  • APIプレビューを活用したクエリパラメータの利用例
  • レンダリング方式ごとの組み込み方法
  • 画面プレビュー
  • コンテンツのWebhookを設定
リッチエディタ
  • リッチエディタの操作方法
  • リッチエディタのWRITE API
  • 旧リッチエディタの操作方法
レビュー機能
  • レビュー
  • AIレビュー
メディア
  • メディア管理
  • メディアのフィルター・表示順の変更
  • メディアのタグ設定
  • メディアのWebhookを設定
  • メディアのカスタムドメイン設定
権限管理
  • メンバーの管理
  • ロール(管理画面の権限管理)
複数環境
  • 複数環境(開発環境)
  • 環境間のAPI設定のマージ
外部連携
  • Amazon S3連携
データログ
  • 監査ログ
  • データ転送量
セキュリティ
  • コンテンツの更新履歴
  • 管理画面のIP制限
  • APIのIP制限
認証設定
  • 2要素認証の設定
  • 2要素認証の必須化
  • シングルサインオン
仕様・制限事項
  • 推奨環境
  • 制限事項/注意事項
コンテンツAPI
  • コンテンツAPIとは
基本操作
  • GET /api/v1/{endpoint}
  • GET /api/v1/{endpoint}/{content_id}
  • POST /api/v1/{endpoint}
  • PUT /api/v1/{endpoint}/{content_id}
  • PATCH /api/v1/{endpoint}/{content_id}
  • DELETE /api/v1/{endpoint}/{content_id}
APIキー
  • APIキー(APIの認証と権限管理)
  • 旧API(X-API-KEYなど)からの移行
レスポンスとエラー処理
  • GET APIのフィールドごとのレスポンス形式
  • GET APIにおけるクエリパラメータの指定
  • コンテンツAPIのエラーレスポンス
マネジメントAPI(ベータ)
  • マネジメントAPIとは
コンテンツ操作
  • GET /api/v1/contents/{endpoint}
  • GET /api/v1/contents/{endpoint}/{content_id}
  • PATCH /api/v1/contents/{endpoint}/{content_id}/status
  • PATCH /api/v1/contents/{endpoint}/{content_id}/createdBy
  • PUT /api/v1/contents/{endpoint}/{content_id}/reservation
メディア操作
  • GET /api/v2/media
  • GET /api/v1/media
  • POST /api/v1/media
  • DELETE /api/v2/media
メンバー操作
  • GET /api/v1/members
  • GET /api/v1/members/{member_id}
API操作
  • GET /api/v1/apis
  • GET /api/v1/apis/{endpoint}
  • POST /api/v1/apis
サービス操作
  • GET /api/v1/service
レスポンスとエラー処理
  • マネジメントAPIのエラーレスポンス
画像API
  • 画像APIとは
主なパラメータ
  • 画像サイズ
  • 品質
  • 解像度・画面サイズ
  • フォーマット
  • テキスト
  • 枠線
  • パディング
  • 形状
  • ダウンロード
  • ウォーターマーク
MCPサーバー
  • microCMS MCP
  • microCMS Document MCP Server
  • トップ
  • コンテンツAPI

GET APIのフィールドごとのレスポンス形式

最終更新日: 2026/04/30

フィールドごとのレスポンス

1. テキストフィールド

1行でテキストを自由入力できるフィールドです。

レスポンスの型

文字列

例

"textField": "some text"

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
キーなし / null

Information

フィールドが空値の場合のレスポンスの詳細につきまして、本ページ下部の一覧を併せてご確認ください。

2. テキストエリア

複数行でテキストを自由入力できるフィールドです。プレーンテキストによる入力となります。

レスポンスの型

文字列

例

"textArea": "some\ntext"

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
キーなし / null

Information

改行を含む場合、\n として出力されます。

3. リッチエディタ

複数行の装飾可能なテキストを自由入力できるフィールドです。

レスポンスの型

文字列(HTML形式)

例

"richEditor": "<p>some text</p>"

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
キーなし / null

4. 旧リッチエディタ

複数行の装飾可能なテキストを自由入力できるフィールドです。

レスポンスの型

文字列(HTML形式)

例

"richEditorOld": "<p>some text</p>"

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
キーなし / ""

5. 画像

画像用のフィールドです。

レスポンスの型

オブジェクト(画像オブジェクト)
※ altは任意の設定項目のため、キー自体が含まれない場合もあります。
※ height と width は、拡張子によっては、キー自体が含まれない場合もあります。

例

"image": {
        "url": "https://images.microcms-assets.io/assets/xxxx/yyyy/image.png.",
        "height": 630,
        "width": 1200,
        "alt": "Some sample alt text."
}

フィールドが空値の場合のレスポンス

キーなし

6. 複数画像

複数の画像用のフィールドです。

レスポンスの型

配列(画像オブジェクトの配列)

例

"imageList": [
        {
            "url": "https://images.microcms-assets.io/assets/xxxx/yyyy/image1.png",
            "height": 630,
            "width": 1200,
            "alt": "Some sample alt text."
        },
        {
            "url": "https://images.microcms-assets.io/assets/xxxx/yyyy/image2.png",
            "height": 630,
            "width": 1200,
            "alt": "Some sample alt text."
        }
]

フィールドが空値の場合のレスポンス

空配列([])

7. 日時

Date型のフィールドです。

レスポンスの型

文字列(日時、ISO 8601形式のUTC(協定世界時))

例

"date": "2023-01-01T00:00:00.000Z"

フィールドが空値の場合のレスポンス

キーなし

8. 真偽値

Boolean型のフィールドです。

レスポンスの型

真偽値(true or false)

例

"boolean": true

フィールドが空値の場合のレスポンス

false

Information

真偽値フィールドの値はデフォルトで false となっています。

9. セレクトフィールド

定義したリストの中から値を選択するフィールドです。

レスポンスの型

配列(事前に定義した選択肢の配列)

例

// 複数選択がOFFのとき
"selectField": ["Apple"]

// 複数選択がONで、複数選択しているとき
"selectField": ["Apple", "ORANGE"]

フィールドが空値の場合のレスポンス

空配列([])

10. コンテンツ参照

他コンテンツを参照するフィールドです。

レスポンスの型

オブジェクト(他コンテンツのデータ)

例

"relationalContent": {
        "id": "xxxxxxxxxx",
        "createdAt": "2023-01-01T00:00:00.000Z",
        "updatedAt": "2023-01-01T00:00:00.000Z",
        "publishedAt": "2023-01-01T00:00:00.000Z",
        "revisedAt": "2023-01-01T00:00:00.000Z",
            "title": "some title"  
}

フィールドが空値の場合のレスポンス

null

11. 複数コンテンツ参照

複数の他コンテンツを参照するフィールドです。

レスポンスの型

配列(他コンテンツのデータの配列)

例

"relationalContentList": [
        {
                "id": "xxxxxxxxxx",
                "createdAt": "2023-01-01T00:00:00.000Z",
                "updatedAt": "2023-01-01T00:00:00.000Z",
                "publishedAt": "2023-01-01T00:00:00.000Z",
                "revisedAt": "2023-01-01T00:00:00.000Z",
                "title": "some title"  
        },
        {
                "id": "yyyyyyyy",
                "createdAt": "2023-02-01T00:00:00.000Z",
                "updatedAt": "2023-02-01T00:00:00.000Z",
                "publishedAt": "2023-02-01T00:00:00.000Z",
             "revisedAt": "2023-02-01T00:00:00.000Z",
                "title": "some title 2" 
        }
]

フィールドが空値の場合のレスポンス

空配列([])

12. 数字

Number型のフィールドです。

レスポンスの型

数値

例

"number": 42

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
キーなし / null

13. カスタムフィールド

作成済みのカスタムフィールドを利用したフィールドです。

レスポンスの型

オブジェクト

例

"customField": {
        "fieldId": "someCustomField",
        // 以降、作成したカスタムフィールドの内容に準ずる
        "title": "some titlte"
}

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
null / {“fieldId”: “someFieldId”}

14. 繰り返しフィールド

作成済みのカスタムフィールドを複数選択し、繰り返し入力できるフィールドです。

レスポンスの型

配列(カスタムフィールドオブジェクトの配列)

例

"repeatField": [
        {
                "fieldId": "someCustomField",
                "title": "some titlte"
        },
        {
                "fieldId": "someCustomField",
                "title": "some titlte 2"
        }
]

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
空配列([]) / null

15. ファイル

ファイル用のフィールドです。レスポンスに、ファイルのURLとファイルサイズ(単位はByte)が含まれます。

レスポンスの型

オブジェクト

例

"file": {
        "url": "https://files.microcms-assets.io/assets/xxxxx/yyyy/files.zip",
        "fileSize": 10000
}

フィールドが空値の場合のレスポンス

キーなし

16. 拡張フィールド

外部データの読み込みができるフィールドです。

レスポンスの型

オブジェクト(アプリケーションから連携されたデータのオブジェクト)

例

"iframe": {
        "id": "123"
}

フィールドが空値の場合のレスポンス

キーなし

Information

拡張フィールドのレスポンスに関する詳細は、拡張フィールドの詳細ページも合わせてご参照ください。
拡張フィールドによる外部データ連携|microCMSドキュメント

フィールドが空値の場合のレスポンス一覧

入力方法ごとに、各フィールドの値が空値だった場合のレスポンス一覧を示します。

管理画面からの入力

CSVインポート

POST/PUT API(※1)

既存APIにフィールドを追加(※2)

PATCH API
(※3)

テキストフィールド

キーなし

キーなし

null

テキストエリア

キーなし

キーなし

null

リッチエディタ

キーなし

キーなし

null

旧リッチエディタ(非推奨)

キーなし

キーなし

""

画像

キーなし

キーなし

キーなし

複数画像

[]

[]

[]

日時

キーなし

キーなし

キーなし

真偽値

false

false

false

セレクトフィールド

[]

[]

[]

コンテンツ参照

null

null

null

複数コンテンツ参照

[]

[]

[]

数字

キーなし

キーなし

null

カスタムフィールド

{"fieldId": "someFieldId", ...}

(※4)

null

{"fieldId": "someFieldId", ...}

(※4)

繰り返しフィールド

[]

null

[]

ファイル

キーなし

キーなし

キーなし

拡張フィールド

キーなし(※5)

キーなし

キーなし

(※1)POST/PUT APIにおいて、空値で登録する方法はそれぞれ「POST /api/v1/{endpoint}」「PUT /api/v1/{endpoint}/{content_id}」をご確認ください。
(※2)すでに登録されているAPIスキーマにフィールドを追加し、既存コンテンツにリクエストした際のレスポンスです。一度、コンテンツを更新すると「管理画面からの入力」と同じレスポンスになります。
(※3)PATCH APIにおいて、空値で登録する方法は「PATCH /api/v1/{endpoint}/{content_id}」をご確認ください。
(※4)レスポンスの値はカスタムフィールドのスキーマ構造によって決定されます。
(※5)一度フィールドにデータを入力した後に、管理画面からデータを空にした場合は、キーはそのまま残り、任意の空値("" , null , [] など)が入ります。

Information

「キーなし」とは、レスポンスに該当フィールドのキー自体を含まない状態を指しています。

目次

  • フィールドごとのレスポンス
  • 1. テキストフィールド
  • 2. テキストエリア
  • 3. リッチエディタ
  • 4. 旧リッチエディタ
  • 5. 画像
  • 6. 複数画像
  • 7. 日時
  • 8. 真偽値
  • 9. セレクトフィールド
  • 10. コンテンツ参照
  • 11. 複数コンテンツ参照
  • 12. 数字
  • 13. カスタムフィールド
  • 14. 繰り返しフィールド
  • 15. ファイル
  • 16. 拡張フィールド
  • フィールドが空値の場合のレスポンス一覧
  • 運営会社
  • 特定商取引法に基づく表記
  • 利用規約
  • プライバシーポリシー

Copyright © microcms.io All rights reserved.