microCMS

GET /api/v1/{endpoint}

リスト形式のAPIにおいてはコンテンツ一覧が取得でき、オブジェクト形式のAPIにおいては単一コンテンツの取得ができます。

オブジェクト形式のAPIの場合はGET /api/v1/{endpoint}/{content_id}と同様の結果が得られるのでそちらをご参照ください。
ここではリスト形式のAPIの場合におけるリクエストヘッダー、クエリストリング、レスポンスについて解説します。

リクエストヘッダー

X-MICROCMS-API-KEY

GET APIリクエストの際に必要な認証キーです。
デフォルト権限もしくは個別権限で「GET」を有効にして、リクエストヘッダーに含めて送信してください。

Information

クライアントサイドから直接APIを呼び出すことでユーザーがキーを把握できてしまう場合、エンドポイントさえ分かればAPIを呼び出せてしまうことにご注意ください。
対処法としては、サーバサイドからAPIを呼び出す、またはJamstack構成にするなどしてキーを漏洩しないことが挙げられます。

下書き全取得

この権限を付与するためにはAPIキーの権限設定で「GET」「下書き全取得」の両方を有効にしてください。

Information

「下書き全取得」は旧X-GLOBAL-DRAFT-KEYにあたる全ての下書き状態のコンテンツを一度に取得する権限です。
複数の下書きコンテンツを同時に取得する必要がある場合に設定をしてください。
(通常、下書き状態のコンテンツを取得するにはコンテンツ毎に生成されたdraftKeyを使用します。)

「下書き全取得」を設定するには同時に「GET」権限を付与することが必要です。

クエリストリング

本APIにはクエリストリングを指定できます。

draftKey

下書き状態のコンテンツを取得するためのパラメータです。 コンテンツの編集画面で確認できるdraftKeyをパラメータとして追加してください。
draftKeyを使って取得できる下書きコンテンツは通常1つのみです。
複数の下書き状態のコンテンツを同時に取得したい場合には、デフォルト権限もしくは個別権限で「下書き全取得」を有効にしてリクエストをしてください。

limit

取得件数を指定します。
デフォルト値は10です。
上限値はありませんが、レスポンスサイズ(レスポンスヘッダのcontent-lengthの値)が約5MBを超えるとエラーが発生します。
そのため、大量のコンテンツの全件取得をしたい場合は下記のoffsetパラメータと組み合わせてページング処理を行ってください。

offset

何件目から取得するかを指定します。
デフォルト値は0です。

orders

取得するコンテンツの並び替えを行います。
デフォルトは管理画面のコンテンツの表示順です。(qパラメータを除く)

並び替え対象とするフィールド名をorders=publishedAtといった形で指定してください。

複数のフィールドを並び替え対象とする場合はorders=publishedAt,-updatedAtのようにカンマ区切りで指定が可能です。

また降順を指定する場合はフィールド名の先頭に-(マイナス)を付与してください。

  • 降順:-publishedAt
  • 昇順:publishedAt


なお、並び替えが可能なのは以下のデータ型を持つフィールドのみです。
これ以外のフィールドを指定しても無視されます。

  • 日付
  • 真偽値(true or false)
  • 数値

q

コンテンツの全文検索を行います。特定のフィールドに対しての検索ではなく、複数のフィールドに対しての検索になります。検索対象となるフィールドは、すべての「テキストフィールド」「テキストエリア」「リッチエディタ」です。

q=queryA,queryBのようにカンマ区切りで複数キーワードを指定することで、AND検索が実施できます。

レスポンスは、ordersパラメータを指定しない場合、キーワードに対する合致度で高い順番にソートされて返却されます。

日本語などのマルチバイト文字列の検索を行う際は、URLエンコードして値を渡す必要がありますのでご注意ください。

Information

こちらの全文検索機能は、コンテンツ内容を形態素解析した結果を元に実行されております。解析の結果次第では、一文字違いで検索結果に違いが発生する場合があります。正確な部分一致検索が必要な場合は、filtersクエリのcontainsの使用をご検討ください。

fields

コンテンツの中で取得する要素を指定します。
fields=title,main_image,updatedAt,author.nameのようにカンマ区切りで値を記載してください。author.organization.nameのようにドットでつないでキーを指定することで参照コンテンツの要素も指定できます。fieldsが指定されていない場合は全ての要素を取得します。

ids

コンテンツのidをfirst_id,second_id,third_idのようにカンマ区切りで指定することで対象コンテンツのみを取得できます。

filters

条件を指定することでコンテンツを絞り込んで取得できます。利用できる条件式は以下の通りです。

equals

指定に一致したコンテンツを取得します。
(例:gender[equals]women

not_equals

指定に一致しないコンテンツを取得します。
(例:gender[not_equals]women

contains

指定した値を含むコンテンツを取得します。
(例:title[contains]おすすめ

Information

検索対象のフィールドに登録されている文字数が多い場合(10,000文字を超える場合など)は、条件に一致していても、ヒットしないケースがございます。
長文の検索は、qクエリをご利用ください。

検索対象が数字フィールドの場合はヒットしません。

not_contains

指定した値を含まないコンテンツを取得します。
(例:title[not_contains]おすすめ

Information

検索対象のフィールドに登録されている文字数が多い場合(10,000文字を超える場合など)は、条件に一致していても、ヒットしないケースがございます。
長文の検索は、qクエリをご利用ください。

検索対象が数字フィールドの場合はヒットしません。

less_than

指定より小さいコンテンツを取得します。
(例:createdAt[less_than]2019-11

greater_than

指定より大きいコンテンツを取得します。
(例:createdAt[greater_than]2019-10

exists

指定した値が存在するコンテンツを取得します。
(例:nextLink[exists]

not_exists

指定した値が存在しないコンテンツを取得します。
(例:nextLink[not_exists]

begins_with

指定した値から始まるコンテンツを取得します。
(例:publishedAt[begins_with]2019-11

Information

検索対象が数字フィールドの場合はヒットしません。

発展した使い方

コンテンツ参照フィールドの指定方法

コンテンツ参照/複数コンテンツ参照を使用していて、参照先のコンテンツによって絞り込みを行う場合、

  • コンテンツ参照の場合は[equals](例:category[equals]uN28Folyn
  • 複数コンテンツ参照の場合は[contains](例:tags[contains]oJIZmiban

をご利用ください。
また絞り込みの条件には、コンテンツIDを使用してください。その他の値は利用できません。

カスタムフィールドの指定方法

カスタムフィールドの場合は、{フィールド名}.{カスタムフィールドのフィールド名}[equals]{VALUE}とすることで、カスタムフィールド内の値を対象に絞り込みが可能です。

繰り返しフィールドの場合は、{フィールド名}.{カスタムフィールドのフィールドID}.{カスタムフィールドのフィールド名}[contains]{VALUE}とすることで、繰り返しフィールド内の値を対象に絞り込みが可能です。

条件式の組み合わせ方法

条件式は[and](AND条件) もしくは[or](OR条件)で 区切ることで複数指定ができます。
条件式を括弧()で囲って一部の式を優先させることも可能です。

例:カテゴリーがエンジニアリングかつ、2019/11/14以降またはタイトルが存在している記事を抽出

$curl --glob "https://{your-service}.microcms.io/api/v1/blog?filters=category[equals]engineering[and](date[begins_with]2019-11-14[or]title[exists])" -H "X-API-KEY: {api-key}"

注意点として、下記のように指定をしてしまうと日付のフォーマットが正しくないためエラーが発生します。

"filters=createdAt[greater_than]" + new Date().toString())
// filters=createdAt[greater_than]Fri Oct 22 2021 17:23:00 GMT+0900 (日本標準時)


例えば次のように指定することで正しく動作します。

"filters=createdAt[greater_than]" + new Date().toISOString())
// filters=createdAt[greater_than]2021-10-22T08:23:05.896Z

depth

参照コンテンツを取得する階層の深さを指定します。
デフォルト値は1、最大値は3です。

例えば、ブログコンテンツに関連記事を表示するために、自分自身を循環参照しているとします。

例)depth = 1の場合

{
  "id": "id1",
  "title": "title1",
  "body": "body1",
  "related_blog": {
    "id": "id2",
    "title": "title2",
    "body": "body2",
    "related_blog": {
      "id": "id3"
    }
  }
}


例)depth = 2の場合

{
  "id": "id1",
  "title": "title1",
  "body": "body1",
  "related_blog": {
    "id": "id2",
    "title": "title2",
    "body": "body2",
    "related_blog": {
      "id": "id3",
      "title": "title3",
      "body": "body3",
      "related_blog": {
        "id": "id4"
      }
    }
  }
}

richEditorFormat

リッチエディタのレスポンス形式を変更できます。

html(デフォルト)

richEditorFormatに html を指定した場合、HTMLとして取得できます。
デフォルトの設定になっており、パラメータに何も指定しない場合もこちらが適用されます。

{
    "title": "更新情報",
    "content": "<h2 id=\"h5ca2740170\">Hello World</h2><p>リッチエディタのフォーマットを<strong>変更</strong>できるようになりました。<br><br><img src=\"https://images.microcms-assets.io/assets/9f54a34e853e4bee98b47ce18c0713f1/c22bcc0296204e81889119c2ffa9a883/domenico-loia-hGV2TfOh0ns-unsplash.jpg\" alt=\"\"><br></p>",
}

object

richEditorFormatに object を指定するとオブジェクト型で取得できます。

{
    "title": "更新情報",
    "content": {
        "contents": [
            {
                "type": "block",
                "value": [
                    {
                        "type": "text",
                        "value": "Hello World",
                        "attributes": {}
                    }
                ],
                "attributes": {
                    "header": 2
                }
            },
            {
                "type": "textBlock",
                "value": [
                    {
                        "type": "text",
                        "value": "リッチエディタのフォーマットを",
                        "attributes": {}
                    },
                    {
                        "type": "text",
                        "value": "変更",
                        "attributes": {
                            "bold": true
                        }
                    },
                    {
                        "type": "text",
                        "value": "できるようになりました。",
                        "attributes": {}
                    },
                    {
                        "type": "text",
                        "value": "\n",
                        "attributes": {}
                    },
                    {
                        "type": "text",
                        "value": "\n",
                        "attributes": {}
                    }
                ]
            },
            {
                "type": "image",
                "value": "https://images.microcms-assets.io/assets/9f54a34e853e4bee98b47ce18c0713f1/c22bcc0296204e81889119c2ffa9a883/domenico-loia-hGV2TfOh0ns-unsplash.jpg",
                "attributes": {
                    "link": null,
                    "target": null,
                    "alt": null,
                    "width": 640,
                    "height": 427
                }
            },
        ]
    },
}

レスポンス

レスポンスの例です。

{
    "contents": [
        {
            "id": "ywsd1lc_z",
            "createdAt": "2022-04-27T02:44:50.280Z",
            "updatedAt": "2022-04-27T02:44:50.280Z",
            "publishedAt": "2022-04-27T02:44:50.280Z",
            "revisedAt": "2022-04-27T02:44:50.280Z",
            "name": "更新情報"
        },
        {
            "id": "t9xe_ys44",
            "createdAt": "2022-04-27T02:44:50.197Z",
            "updatedAt": "2022-04-27T02:44:50.197Z",
            "publishedAt": "2022-04-27T02:44:50.197Z",
            "revisedAt": "2022-04-27T02:44:50.197Z",
            "name": "チュートリアル"
        },
        {
            "id": "4sqeq8g36n8",
            "createdAt": "2022-04-27T02:44:50.068Z",
            "updatedAt": "2022-04-27T02:44:50.068Z",
            "publishedAt": "2022-04-27T02:44:50.068Z",
            "revisedAt": "2022-04-27T02:44:50.068Z",
            "name": "テクノロジー"
        }
    ],
    "totalCount": 3,
    "offset": 0,
    "limit": 10
}


取得したAPIの値は contents という配列で返されます。それに加え以下の値がレスポンスに含まれます。

totalCount

APIに含まれるコンテンツの総数です。

limit

取得件数を指定した値です。
デフォルト値は10です。

offset

何件目から取得するかを指定した値です。
デフォルト値は0です。