GET /components

ウェブサイトのカスタムコンポーネント（コンテンツタイプスキーマ）のサマリーを一覧表示します。

ウェブサイトのカスタムコンポーネント（コンテンツタイプスキーマ）のサマリーを名前順に一覧表示します。ユーザー定義のカスタムスキーマのみが返されます。

認証: APIキー（x-api-key ヘッダーまたは api_key クエリパラメーター）。

クエリパラメーター

パラメーター	型	必須	備考
`websiteId`	uuid	はい	有効なUUIDである必要があります。このエンドポイントでは `Host`/config のフォールバックはありません。
`state`	string	いいえ	ライフサイクル状態でフィルタリングします: `draft`、`active`、`archived`。
`api_key`	string	いいえ	`x-api-key` ヘッダーの代替。

レスポンス

コンポーネントサマリーのJSON配列:

[
  {
    "id": "...",
    "name": "post",
    "displayName": "投稿",
    "description": "ドキュメント用の投稿",
    "category": "Custom",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "custom",
    "version": 8,
    "routeSlugField": "title"
  }
]

source は常に "custom" です。displayName は未設定の場合に name を使用し、category は未設定の場合に "Custom" を既定値とします。

例

curl '{CMS_API_URL}/components?websiteId=<uuid>&state=active' \
  -H 'x-api-key: <key>'

エラー

400 — websiteId が不足しているか無効です
401 — APIキーが無効です

Previous‹GET /blocks/generated NextGET /components/{name}›