KAkarte
Contents

Get contents list

Craft Cross CMSに保存したコンテンツの一覧を取得します。

Required Scope

APIの実行に必要なScopeです。

beta.cms.content.list

Required Role

管理画面でScopeを追加する際に必要な権限です。

Craft Cross CMS > CMSの閲覧
post/v2beta/cms/content/list

Request

  • Base URL
    https://api.karte.io
  • URL
    https://api.karte.io/v2beta/cms/content/list
  • Auth
    HTTP bearer

Headers

x-karte-apistring

今後利用する可能性のある予約語です。現在は設定不要です。

authorizationstring

認証情報を含むトークンです。"Authorization" ヘッダーに Bearer <token> の形式で設定してください。

content-typestring

リクエストのコンテンツタイプを指定します。通常は application/json を使用してください。

Request body

modelIdstring required
filterobject
selectstring[]
orderstring[]
skipinteger
limitinteger

Response

A successful response.

skipinteger required

何件のリソースをスキップしているか表します。

limitinteger required

最大何個のリソースを取得するか表します。

totalinteger required

条件に合致するリソースが何個あるか表します。

Example response

{
  "limit": 100,
  "total": 246,
  "items": [
    {
      "id": "6109f05d5d18d6006af5f385",
      "title": "title1",
      "body": {
        "text": "Rich Text",
        "html": "<h1>Rich Text</h1>",
        "json": {
          "type": "doc",
          "content": [
            {
              "type": "heading",
              "attrs": {
                "level": 1
              },
              "content": [
                {
                  "type": "text",
                  "text": "RichText"
                }
              ]
            }
          ]
        }
      },
      "sys": {
        "customOrder": 15,
        "modelId": "6347f05d5d18d4536af5f336",
        "raw": {
          "createdAt": "2025-04-06T00:18:26.810Z",
          "createdBy": "6757a6444bf949f948348941",
          "updatedAt": "2025-04-06T08:39:45.628Z",
          "updatedBy": "6757a6444bf949f948348941",
          "firstPublishedAt": "2025-04-06T00:18:26.810Z",
          "publishedAt": "2025-04-06T08:39:45.628Z",
          "contentId": "6109f05d5d18d6006af5f385",
          "revisionId": "67ce733b3640300ad776d80e",
          "publishedRevisionId": "67ce733b3640300ad776d80e"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.