microCMS
Documentation
  • Pricing
  • Blog
  • FAQ
  • Contact
  • Sign In
  • Get started for free
Navigation
Tutorial
Next.js
  • Integration with Next.js
  • Getting Started with App Router
  • Tutorial (App Router)
  • Getting Started with Pages Router
  • Tutorial (Pages Router)
Astro
  • Getting Started
  • Integration with Astro
  • Tutorial
Nuxt
  • Integration with Nuxt
  • Getting Started
  • Tutorial
Gatsby
  • Integration with Gatsby
  • Getting Started
  • Tutorial
JavaScript
  • Integration with JavaScript
  • Getting Started (Browser)
  • Getting Started (Server)
PHP
  • Integration with PHP
  • Getting Started
Ruby
  • Integration with Ruby
  • Getting Started
Go
  • Integration with Go
  • Getting Started with microCMS
Manual
  • Introduction
Account & Login
  • Account Registration
  • Login
  • Email Address Authentication
Services
  • Creating a Service
  • Service Configuration
  • Template
  • Service Deletion
Payment
  • Change of Pricing Plan
  • Registering and Changing Payment Methods
API
  • Creating and Managing APIs
  • API Settings
  • Export/Import of API Schema
Fields
  • Text Field
  • Text Area
  • Image
  • Multiple Images
  • Date
  • Boolean
  • Selectable Field
  • Content Reference
  • Multiple Content References
  • Number
  • File
  • Extended Field
  • Repetition
  • Custom
Contents
  • CSV Export of Content
  • Content Creation
  • Content Editing
  • Content Management
  • View
  • Content Status
  • Custom Status
  • Setting the Content ID
  • Automatically Assigned Values for Content
  • CSV Import of Content
  • API Preview
  • Examples of Using Query Parameters with API Preview
  • Integration Methods by Rendering Type
  • Screen Preview
  • Setting Up Webhooks for Content
Rich Editor
  • How to Use the Rich Editor
  • Rich Editor WRITE API
  • How to Use the Old Rich Editor
Reviews
  • Review
  • AI Review
Media
  • Media Management
  • Changing Media Filters and Display Order
  • Media Tag Configuration
  • Setting Up Media Webhooks
  • Custom Domain Settings for Media
Permission Management
  • Member Management
  • Roles (Permission Management in the Admin Panel)
Environments
  • Multiple Environments (Development Environment)
  • Merging API Settings Between Environments
Connection
  • Amazon S3 Integration
Logs
  • Audit Log
  • Data Transfer Volume
Security
  • Content Update History
  • IP Restrictions for Management Dashboard
  • IP Restrictions for APIs
Authentication
  • Setting Up Two-Factor Authentication
  • Mandatory Two-Factor Authentication
  • Single Sign-On
Specifications & Limitations
  • Recommended Environment
  • Limitations / Precautions
Content API
  • What is the Content API?
Basic Operations
  • 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 Keys
  • API Key (API Authentication and Authorization Management)
  • Migration from the Old API (X-API-KEY, etc.)
Responses & Error Handling
  • Response format for each field in the GET API
  • Specifying Query Parameters in the GET API
  • Error Responses of the Content API
Management API (Beta)
  • POST /api/v1/roles
  • DELETE /api/v1/roles/{role_id}
  • GET /api/v1/roles/{role_id}
  • PATCH /api/v1/roles/{role_id}
  • GET /api/v1/roles
  • What is the Management API?
Content Operations
  • PUT /api/v1/contents/{endpoint}/{content_id}/reservation
  • 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
Media Operations
  • GET /api/v2/media
  • GET /api/v1/media
  • POST /api/v1/media
  • DELETE /api/v2/media
Member Operations
  • PATCH /api/v1/members/{member_id}
  • GET /api/v1/members
  • GET /api/v1/members/{member_id}
API Operations
  • POST /api/v1/apis
  • GET /api/v1/apis
  • GET /api/v1/apis/{endpoint}
Service Operations
  • GET /api/v1/service
Responses & Error Handling
  • Management API Error Responses
Image API
  • What is the Image API?
Parameters
  • Image Size
  • Quality
  • Resolution and Screen Size
  • Format
  • Text
  • Border
  • Padding
  • Shape
  • Download
  • Watermark
MCP Server
  • microCMS MCP
  • microCMS Document MCP Server
  • Top
  • Manual

Custom

Last updated: 2026/09/02

Custom Fields are a feature that allows you to combine multiple fields and adjust layouts based on selectable fields in the API schema.

How to Create

Custom Fields can be created for each API.
Clicking the "Custom Fields" link in the upper right corner of the screen when selecting an API will take you to the list of Custom Fields.



After that, you can transition to the Custom Field creation screen by clicking the "Add" button.

Here, we will introduce an example of creating a Custom Field that summarizes meta information.

Enter Basic Information for the Custom Field

First, set the "Custom Field Name" and "Custom Field ID".


Define the API Schema

Next, design the necessary schema within the Custom Field.
This time, we will prepare three items as meta information: Title / Summary / OGP Image.

Specify the Layout

Finally, specify the layout.
You can choose between 1 column or 2 columns, and you can change the position of each input form by dragging and dropping.
This time, we will place the title and summary in the left column and the OGP image in the right column.



With this, the creation of the Custom Field is complete. After creation, it will be displayed on the list screen of Custom Fields.


How to Set Up Fields

To use the created Custom Fields, navigate to "API Settings" > "API Schema".
Select "Custom" from the field types.



When you select "Custom", a select box will appear, allowing you to choose the Custom Field "Meta Information" that you created earlier.



Ultimately, the schema settings will look like the one below.



Save the changes to the schema, and the setup of the Custom Fields is complete.

How to Submit Data

When you transition to the content editing screen, the following input screen will be displayed.



In the editing screen of the content where the Custom Fields are placed, the contents of the defined schema will be displayed as a single group (box).
Within the group, each pre-configured field is arranged, and you can submit data using the same operations as with regular fields.

For submissions using API and CSV, please refer to the following documentation.

POST /api/v1/{endpoint}
https://document.microcms.io/en/content-api/post-content#h4ad852ed2c
CSV Import of Content
https://document.microcms.io/en/manual/csv-import#had265a33b7

Limitations / Notes

  • There is no upper limit on the number of Custom Fields that can be set.
  • You cannot define Custom Fields within Custom Fields. As an alternative, please consider using the Repeat Field.
  • Custom Field settings cannot be shared across APIs. Please set them for each API individually.

Field Detailed Settings

Setting Item

Description

Required Field

When enabled, input will be required during submission.

Description

This is the description displayed on the submission screen.

Custom Field

Set the custom fields to be used.

Items Displayed on the List Screen

You can choose from the default (the number of fields with values set) or items from the text field. If the specified item does not exist, the default display will be shown.

API Response

The response when using Custom Fields is returned in object format.
Please refer to the documentation below for more details.

Response format for each field in the GET API
https://document.microcms.io/en/content-api/get-api-field-responses#hf658894fa7

How to Use in Frontend

Custom Fields return data in object format, so you specify the properties (the field IDs defined within the Custom Field) to retrieve the information.
Below is an implementation example using generateMetadata in Next.js to reflect the values of the meta information in the page's meta tags.

export async function generateMetadata({ params }) {
  const { slug } = await params;

  // Fetch data using the microCMS JavaScript SDK (https://github.com/microcmsio/microcms-js-sdk)
  const data = await client.getListDetail({
    endpoint: "blog",
    contentId: slug,
  });

  return {
    // meta is the field ID. Please replace it with the actual field ID
    title: data.meta.title,
    description: data.meta.description,
    openGraph: {
      title: data.meta.title,
      description: data.meta.description,
      images: [data.meta.image.url],
    },
  };
}

export default async function Page({ params }) {}

Other Use Cases

We also have the following blogs as implementation examples, so please refer to them as well.

microCMSのカスタムフィールドを使ってランディングページを作ろう | microCMSブログ
https://blog.microcms.io/custom-field-lp/
カスタムフィールドを使用してブログにCVエリアを追加しよう | microCMSブログ
https://blog.microcms.io/nuxt-cv-point/

Contents

  • How to Create
  • Enter Basic Information for the Custom Field
  • Define the API Schema
  • Specify the Layout
  • How to Set Up Fields
  • How to Submit Data
  • Limitations / Notes
  • Field Detailed Settings
  • API Response
  • How to Use in Frontend
  • Other Use Cases
  • Company
  • Legal Notice
  • Terms of Service
  • Privacy Policy

Copyright © microcms.io All rights reserved.