サービスに含まれるメディア情報を取得できるAPIです。

リクエストヘッダー

X-MICROCMS-API-KEY

GET APIリクエストの際に必要な認証キーです。
マネジメントAPIの権限で「メディアの取得」を有効にして、リクエストヘッダーに含めて送信してください。

レスポンス例

こちらがマネジメントAPIで取得したメディア一覧のレスポンス例です。

{
  "media": [
    {
      "id": "e803c1fa-368d-4087-b937-646db9f6e328",
      "createdAt": "2025-02-28T05:34:48.722Z",
      "updatedAt": "2026-04-08T01:32:39.694Z",
      "url": "https://images.microcms-assets.io/assets/9895824867684c2994e22452171b8c11/8f3b1b376ee84cc4acf12af148f9999d/sample1.png",
      "width": 1200,
      "height": 800,
      "tags": [
        "drawings",
        "animals"
      ]
    },
    {
      "id": "52d27e9a-5ada-4c22-9fe9-df2dec7ca1fd",
      "createdAt": "2026-04-08T01:32:10.812Z",
      "updatedAt": "2026-04-08T01:32:22.642Z",
      "url": "https://images.microcms-assets.io/assets/9895824867684c2994e22452171b8c11/d7bcc402720f471f9f36de5eca4057c5/sample2.png",
      "width": 1200,
      "height": 800,
      "alt": "walking with dog in the park",
      "tags": []
    }
  ],
  "totalCount": 2,
   "token": "FGluY2x1ZGVfY29ud...R0cHljVU5KUQ==" // 一部省略
}

クエリパラメータ

本APIにはパラメータを指定できます。

limit

取得件数を指定します。
デフォルト値は10です。上限値は100です。

imageOnly

動画やPDFなどのファイルは除き、画像のみを取得したい場合に指定するパラメータです。
画像のみを取得する場合はtrueを指定してください。
デフォルト値はfalseです。

fileName

ファイル名による絞り込みを行うためのパラメータです。指定した文字列で拡張子を含むファイル名を検索し、ヒットしたメディアが取得されます。
デフォルトでは絞り込みは行われません。

tags

タグによる絞り込みを行うためのパラメータです。
tags=drawings,animals のようにカンマ区切りで複数指定した場合は、指定したすべてのタグが付与されたメディアが取得されます。
デフォルトでは絞り込みは行われません。

alt

代替テキストによる絞り込みを行うためのパラメータです。指定した文字列でメディアの代替テキストを検索し、ヒットしたメディアが取得されます。
デフォルトでは絞り込みは行われません。

token

前回のリクエストの続きからコンテンツを取得するためのパラメータです。
初回のレスポンスに含まれる token の値を指定してください。

2回目以降のリクエストについて

初回のリクエストで limit および imageOnly パラメータが付与されている場合、明示的に付与せずともそれらの条件が引き継がれます。