The Content API is the fundamental API for retrieving and registering data in microCMS. Typically, data obtained from this API is used to build websites and applications.

Base URL

https://{SERVICE_ID}.microcms.io

Specifications

• Using the Content API requires authentication via an API key. You can restrict the operations available for the API key by granting permissions. Please refer to the API key documentation for more details.

• For information on the error responses of the Content API, please refer to the following documentation.

• The data from the Content API is delivered via a CDN. For details on the conditions under which the CDN cache is utilized, please refer to the help below.

Limitations

• For limitations related to the entire Content API, please refer to the Limitations Document.
• For limitations specific to each API, please refer to their individual pages.

Types of APIs

GET

This is the API used to retrieve content. When using data registered from the management screen, this API is utilized. There are two types of APIs for retrieving the content list and the content details.

POST / PUT

This is the API for creating content. It is used for migrating content from other CMSs and managing simple form submission data.
The POST API automatically generates a content ID, while the PUT API allows you to specify a custom content ID.

PATCH

This is an API for rewriting the content of registered content. It is used in cases where the contents of an external database are batch processed and linked to the CMS.

DELETE

This is the API for deleting registered content.