Collections

List collections

Craft Cross CMSのコレクション一覧を取得します。

ページング

  • 初回取得: skip: 0, limit: 100 で最初の100件を取得
  • 次のページ: skip: 100, limit: 100 で次の100件を取得
  • レスポンスの total でコレクション総数を確認可能

Required Scope

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

beta.cms.collection.list

Required Role

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

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

Request

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

Headers

x-karte-apistring

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

authorizationstring

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

content-typestring

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

Request body

skipinteger

スキップする件数

limitinteger

取得する最大件数

Response

成功レスポンス

skipinteger required

何件のコレクションをスキップしているか表します。ページネーションで利用します。

limitinteger required

最大何個のコレクションを取得するか表します。ページネーションで利用します。

totalinteger required

条件に合致するコレクションが何個あるかを表します。

Example response

{
  "limit": 100,
  "total": 1,
  "items": [
    {
      "id": "6347f05d5d18d4536af5f336",
      "name": "Blog Posts",
      "description": "ブログ記事を管理するコレクション"
    }
  ]
}

Changes

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