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/v1/apis/{endpoint}

最終更新日: 2026/07/09

指定したAPIのスキーマ情報(フィールド定義やカスタムフィールドの構成)を取得できるAPIです。

リクエストヘッダー

X-MICROCMS-API-KEY

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

Caution

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

レスポンスボディ

基本的には、APIスキーマのエクスポートでエクスポートしたJSONと同様のデータがレスポンスとして返却されます。
こちらがマネジメントAPIで取得したAPI情報のレスポンス例です(※例として一部のフィールドのみとなります。全ての種別のフィールドを網羅してはおりません)。

{
    "apiFields": [
        {
            "fieldId": "title",
            "name": "タイトル",
            "kind": "text",
            "description": null,
            "required": false,
            "textSizeLimitValidation": null,
            "patternMatchValidation": null,
            "isUnique": false,
            "initialValue": null
        },
        {
            "fieldId": "body",
            "name": "本文",
            "kind": "richEditorV2",
            "description": null,
            "required": false,
            "richEditorV2Options": [
                "headerOne",
                "headerTwo",
                "headerThree",
                "headerFour",
                "headerFive",
                "undo",
                "redo",
                "paragraph",
                "bold",
                "italic",
                "underline",
                "strike",
                "code",
                "blockquote",
                "codeBlock",
                "listBullet",
                "listOrdered",
                "link",
                "image",
                "file",
                "table",
                "horizontalRule",
                "textAlign",
                "customClass",
                "oembedly",
                "clean",
                "color",
                "size"
            ],
            "richEditorV2ColorList": [],
            "richEditorV2HideColorPicker": false,
            "richEditorV2FontSizeList": [],
            "customClassList": []
        },
        {
            "fieldId": "tags",
            "name": "タグ",
            "kind": "select",
            "description": null,
            "required": false,
            "selectItems": [
                {
                    "id": "5EfR-A1XsD",
                    "value": "更新情報"
                },
                {
                    "id": "i4B3HBpTGI",
                    "value": "チュートリアル"
                },
                {
                    "id": "ZGZjQPTtds",
                    "value": "お知らせ"
                }
            ],
            "multipleSelect": true,
            "initialValue": [
                "DEFAULT"
            ]
        },
        {
            "fieldId": "category",
            "name": "カテゴリ",
            "kind": "relation",
            "description": null,
            "required": false,
            "listViewFieldId": "DEFAULT",
            "referencedApiEndpoint": "categories"
        },
        {
            "fieldId": "image-w-name",
            "name": "名前付き画像(単体)",
            "kind": "custom",
            "description": null,
            "required": false,
            "listViewFieldId": "DEFAULT",
            "customFieldId": "image-w-name"
        },
        {
            "fieldId": "image-w-name-list",
            "name": "名前付き画像リスト",
            "kind": "repeater",
            "description": null,
            "required": false,
            "repeaterCountLimitValidation": null,
            "customFieldIds": [
                "image-w-name"
            ]
        }
    ],
    "customFields": [
        {
            "fieldId": "image-w-name",
            "name": "名前付き画像",
            "fieldOrderByColumn": [
                [
                    "name"
                ],
                [
                    "image"
                ]
            ],
            "fields": [
                {
                    "fieldId": "name",
                    "name": "名前",
                    "kind": "text",
                    "description": null,
                    "required": false,
                    "textSizeLimitValidation": null,
                    "patternMatchValidation": null,
                    "isUnique": false,
                    "initialValue": null
                },
                {
                    "fieldId": "image",
                    "name": "画像",
                    "kind": "media",
                    "description": null,
                    "required": false,
                    "imageSizeValidation": null,
                    "initialValue": null
                }
            ]
        }
    ]
}
Information

管理画面のAPIエクスポートでエクスポートしたAPIスキーマのJSONとは、キーの並び順などが異なることがあります。

目次

  • リクエストヘッダー
  • X-MICROCMS-API-KEY
  • レスポンスボディ
  • 運営会社
  • 特定商取引法に基づく表記
  • 利用規約
  • プライバシーポリシー

Copyright © microcms.io All rights reserved.