This is an API that allows you to retrieve media information included in the service.
Starting from December 2023, we will provide a new endpoint for retrieving media information (GET api/v2/media). We recommend using this in the future.
We have confirmed a known issue where if you try to retrieve more than 10,000 media items (by setting the offset to a value greater than 10,000), the data cannot be retrieved correctly.
To retrieve media information exceeding 10,000 items, please use GET /api/v2/media.
This is the authentication key required for GET API requests.
Please enable "Retrieve Media" 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 response for the media list obtained from the Management API.
{
"media": [
{
"id": "e803c1fa-368d-4087-b937-646db9f6e328",
"url": "https://images.microcms-assets.io/assets/9895824867684c2994e22452171b8c11/test.png",
"width": 591,
"height": 138
},
{
"id": "52d27e9a-5ada-4c22-9fe9-df2dec7ca1fd",
"url": "https://images.microcms-assets.io/assets/9895824867684c2994e22452171b8c11/d7bcc402720f471f9f36de5eca4057c5/example.png",
"width": 808,
"height": 177
}
],
"totalCount": 8,
"limit": 2,
"offset": 0
}This API allows you to specify parameters.
Specifies the number of items to retrieve.
The default value is 10. The maximum value is 100.
Shifts the starting position for content retrieval back by the specified value.
The default value is 0.
This parameter is used when you want to retrieve only images, excluding files such as videos and PDFs.
To retrieve only images, specify true.
The default value is false.