This API allows you to retrieve schema information for the specified API (field definitions and the structure of Custom Fields).

Request Header

X-MICROCMS-API-KEY

This is the authentication key required for GET API requests to the Management API.
Please enable "Retrieve API Information" with the default permissions of the Management API and include it in the request header when sending.

Response Body

Basically, the data returned in the response is similar to the JSON exported via API Schema Export.
Here is an example of the response for the API information obtained from the Management API.

{
  "apiFields": [
    {
      "fieldId": "title",
      "name": "Title",
      "kind": "text",
      "required": false
    },
    {
      "fieldId": "body",
      "name": "Body",
      "kind": "richEditorV2",
      "required": false
    },
    {
      "fieldId": "tags",
      "name": "Tags",
      "kind": "select",
      "required": false,
      "multipleSelect": true,
      "selectInitialValue": [],
      "selectItems": [
        {
          "id": "Hc1QzudmqV",
          "value": "Update Information"
        },
        {
          "id": "Fx0fDbBj7S",
          "value": "Tutorial"
        },
        {
          "id": "_SczHMUJgH",
          "value": "Notice"
        }
      ]
    },
    {
      "fieldId": "image",
      "name": "Image",
      "kind": "custom",
      "required": false,
      "customFieldCreatedAt": "2025-09-26T06:21:39.128Z"
    }
    {
      "fieldId": "category",
      "name": "Category",
      "kind": "relation",
      "required": false,
      "referencedApiEndpoint": "categories"
    }
  ],
  "customFields": [
    {
      "createdAt": "2025-09-26T06:21:39.128Z",
      "fieldId": "image-w-name",
      "name": "Named Image",
      "fields": [
        {
          "idValue": "7d5MaoOs3o",
          "fieldId": "name",
          "name": "Name",
          "kind": "text",
          "required": false
        },
        {
          "idValue": "bFhsk2ZidD",
          "fieldId": "image",
          "name": "Image",
          "kind": "media",
          "required": false
        }
      ],
      "position": [
        [
          "7d5MaoOs3o",
          "bFhsk2ZidD"
        ]
      ],
      "updatedAt": "2025-09-26T06:22:22.33Z"
    }
  ]
}

Values Obtainable Only via the Management API

• In the Management API, you can obtain the endpoint of the referenced API for content reference and multiple content references as referencedApiEndpoint.
  • However, when importing the obtained data via API import, this value will be ignored.