---
title: "Get a collection"
method: POST
path: "/v2beta/cms/collection/get"
tags: ["Collections"]
---

# Get a collection

`POST /v2beta/cms/collection/get`

## Request

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

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

#### Required Scope
APIの実行に必要なScopeです。
```
beta.cms.collection.get
```

#### Required Role
管理画面でScopeを追加する際に必要な権限です。
```
Craft Cross CMS > CMSの閲覧
```

## Headers

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

## Request body

- object
  - `collectionId` string, required: コレクションのID

## Response `200`

A successful response.

- Collection
  - `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)