---
title: "List assets"
method: POST
path: "/v2beta/cms/asset/list"
tags: ["Assets"]
---

# List assets

`POST /v2beta/cms/asset/list`

## Request

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

Craft Cross CMSのアセット一覧を取得します。

#### ページング
- 初回取得: `skip: 0, limit: 100` で最初の100件を取得
- 次のページ: `skip: 100, limit: 100` で次の100件を取得
- レスポンスの `total` でアセット総数を確認可能

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

#### Required Role
管理画面でScopeを追加する際に必要な権限です。
```
Craft Cross CMS > メディアライブラリの閲覧
```

## Headers

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

## Request body

- object
  - `skip` integer: スキップする件数
  - `limit` integer: 取得する最大件数

## Response `200`

成功レスポンス

- object: アセットの一覧です。
  - `skip` integer, required: 何件のアセットをスキップしているか表します。
  - `limit` integer, required: 最大何個のアセットを取得するか表します。
  - `total` integer, required: 条件に合致するアセットが何個あるかを表します。
  - `items` Asset[], required: 取得したアセットの配列です。
    - `id` string, required: アセットID
    - `sys` object, required
      - `createdAt` string, required: アセットの作成日時
      - `createdBy` string, required: アセット作成者のアカウントID
      - `updatedAt` string, required: アセットの更新日時
      - `updatedBy` string, required: アセットの更新者のアカウントID
      - `publishedAt` string, nullable: アセットの公開日時
    - `title` string, required: アセットのタイトル
    - `description` string, required: アセットの説明
    - `altText` string, required: アセットの代替テキスト
    - `tagIds` string[], required: アセットに紐づくタグのIDリスト
    - `file` object, required
      - `name` string, required: ファイル名
      - `mimeType` string, required: ファイルのMIMEタイプ
      - `src` string, required: アセットのソースURL
      - `size` number, required: ファイルサイズ（バイト）
      - `width` number: 画像の幅（画像の場合）。幅と高さを読み取れない画像では省略されます
      - `height` number: 画像の高さ（画像の場合）。幅と高さを読み取れない画像では省略されます

## 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)