---
title: "List collections"
method: POST
path: "/v2beta/cms/collection/list"
tags: ["Collections"]
---

# List collections

`POST /v2beta/cms/collection/list`

## Request

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

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の閲覧
```

## Headers

- `x-karte-api` string
- `authorization` string
- `content-type` string

## Request body

- object
  - `filter` object: 検索条件のフィルタ
    - `id` object
      - `$eq` string, required: 完全一致するコレクションID
  - `skip` integer: スキップする件数
  - `limit` integer: 取得する最大件数

## Response `200`

成功レスポンス

- object: コレクションの一覧です。
  - `skip` integer, required: 何件のコレクションをスキップしているか表します。ページネーションで利用します。
  - `limit` integer, required: 最大何個のコレクションを取得するか表します。ページネーションで利用します。
  - `total` integer, required: 条件に合致するコレクションが何個あるかを表します。
  - `items` Collection[], required: 取得したコレクションの配列です。
    - `id` string, required: コレクションのID
    - `name` string, required: コレクション名
    - `description` string, required: コレクションの説明

## Other responses

- `400`: Bad Request. CMS Management API 400 responses include a non-empty detail.

---

[API](https://skmtc.dev/karte/apis/cms-management.md) - [All operations](https://skmtc.dev/karte/apis/cms-management/llms.txt) - [OpenAPI document](https://skmtc.dev/karte/apis/cms-management/revisions/275f2d6496ec?raw)