This is an API that allows you to retrieve the meta information of content specified by the id in a list-type API.
This is the authentication key required for GET API requests.
Please enable "Retrieve Content (List/Detail)" with the default permissions of the Management API and include it in the request header when sending.
If the X-MICROCMS-API-KEY is identifiable, it may allow unauthorized manipulation of content by third parties. Please handle it with care. For more details, please refer to "API Key (API Authentication and Authorization Management)".
This is an example of the content details response obtained from the Management API.
{
"id": "contentId",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"publishedAt": "2019-08-24T14:15:22Z",
"revisedAt": "2019-08-24T14:15:22Z",
"closedAt": null,
"status": [
"DRAFT"
],
"customStatus": null,
"draftKey": "draftKey",
"createdBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
"updatedBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
"reservationTime": {
"publishTime": "2019-08-24T14:15:22Z",
"stopTime": "2019-08-24T14:15:22Z"
}
}The response includes the following items.
Value | Description |
|---|---|
| The ID of the content. |
| The date and time when the content was created. |
| The date and time when the content was last updated. |
| The date and time when the content was published. If it has never been published, |
| The date and time when the currently published content was updated. If it has never been published, |
| The draft key (draftKey) that can be obtained from the management screen. It will be |
| The date and time when the publication ended. If it has never been closed, |
| The status of the content. It can be one of |
| The information of the custom status that has been set. If not set, |
| The ID of the member who created the content. |
| The ID of the member who last edited the content. |
| Information regarding the reservation for the start and end of publication. If neither the start nor end reservation is set, If either the start or end reservation is set, it will include Example: If only the start reservation is set "reservationTime": { "publishTime": "2024-12-25T06:45:00Z", "stopTime": null } |
The following values are specific to the Management API. These values are not included in the Content API.
draftKeyclosedAtstatuscustomStatuscreatedByupdatedByreservationTimeFor content with a custom status set, the customStatus will be included in the response as follows:
{
"id": "contentId",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"publishedAt": "2019-08-24T14:15:22Z",
"revisedAt": "2019-08-24T14:15:22Z",
"status": [
"PUBLISH"
],
// This customStatus will be newly added.
// If customStatus is not supported by the plan or not set, it will be null.
"customStatus": [
{
"key": "USER_DEFINED_CUSTOM_STATUS_KEY123",
"description": "This is a user-defined custom status.",
"name": "Custom Status Test",
"behaviour": "PUBLISH",
"color": "#a20063",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"draftKey": "draftKey",
"createdBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
"updatedBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
"reservationTime": {
"publishTime": "2019-08-24T14:15:22Z",
"stopTime": "2019-08-24T14:15:22Z"
}
}
For more details about custom status, please refer to the documentation below.
