This is an API that allows you to retrieve media information included in the service.

Request Header

X-MICROCMS-API-KEY

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.

Response Example

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
}

Query Parameters

This API allows you to specify parameters.

limit

Specifies the number of items to retrieve.
The default value is 10. The maximum value is 100.

offset

Shifts the starting position for content retrieval back by the specified value.
The default value is 0.

imageOnly

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.