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)
  • 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
  • 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

Content Reference

Last updated: 2026/08/21

The content reference is a field that allows you to link content managed by another API.
It is used to associate information such as linking an "author (from another API)" to an article or linking a "category (from another API)" to a product, facilitating information sharing and relationships.

How to Upload Data

GIF image showing the operation of the content reference field


Clicking on the field will display a modal window with a list of reference content, from which you can select the content you want to link.

Supplement

  • In the content list screen, the "Content ID" of the reference content is displayed by default.
  • If you want to change the items displayed in the content list screen, you can do so from "API Settings > API Schema > Advanced Settings > Items to Display in List Screen." Please check the Advanced Settings for configurable items.
  • If there are many filtered contents, you can use the search box in the upper left to narrow down the desired data.
  • From "Edit Display Items," you can customize the items displayed in the list to make selection easier.
  • If the data you want to reference is not registered, you can create it on the spot using the [+ Create New] button in the upper right, and after saving, you can select it from the list to link.


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

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

Checking Referenced Content

A capture highlighting the 'Referenced n times' link displayed at the top of the content detail screen.


If a specific content is referenced by other contents, a button labeled [Referenced n times] will appear in the upper right corner of the content detail screen, allowing you to check the current number of references.
Clicking this button will display a list of the referencing contents in a modal window.

Limitations / Notes

  • If you want to link multiple contents, please use the "Multiple Content References".
  • If you do not have viewing permissions for the API that is the reference destination, you will not be able to select contents or check the selection status.
  • If the selected content is in draft or has ended publication, it will not be included in the API response. It can be retrieved if the API key has permissions for "Retrieve all draft contents" or "Retrieve all ended publication contents".
  • As a known issue, there may be cases where unreferenced content is linked to "Referenced 0 times". For more details, please refer to the help article "Unreferenced content is linked to 'Referenced 0 times' and cannot be deleted. What should I do?".

Advanced Settings

Setting Item

Description

Required Field

When set to ON, input is required during submission.

Description

This is the description displayed on the submission screen.

Referenced Content

Select the API to reference. This can only be selected when creating a new entry.

Items Displayed on the List Screen

You can select items to display on the contents list screen from Content ID or text field items. If the specified item does not exist, the Content ID will be displayed instead.

Default Value

You can set the default value for submission.

Response Format of GET API

Please refer to the documentation below for details.

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

How to Use in Frontend

The content reference field returns data in object format, so you specify the properties (field IDs) of the referenced content to display the information.
Below is an implementation example in Next.js that displays the author (writer) information linked to the article details.

export default async function Page({ 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 (
    <main>
      <h1>{data.title}</h1>

      {/* writer is the field ID. Please replace it with the actual field ID */}
      <div>
        <Image
          src={data.writer.profileImage.url}
          alt={data.writer.profileImage.alt || ""}
          width={100}
          height={100}
        />
        <h2>{data.writer.name}</h2>
        <p>{data.writer.description}</p>
      </div>

      <div>{data.content}</div>
    </main>
  );
}

Contents

  • How to Upload Data
  • Supplement
  • Checking Referenced Content
  • Limitations / Notes
  • Advanced Settings
  • Response Format of GET API
  • How to Use in Frontend
  • Company
  • Legal Notice
  • Terms of Service
  • Privacy Policy

Copyright © microcms.io All rights reserved.