Надає зведення користувацьких компонентів (схем типів вмісту) вебсайту.
Перелічує стислий опис користувацьких компонентів (схем типів вмісту) для вебсайту, впорядкований за назвою. Повертаються лише користувацькі схеми, визначені користувачем.
Автентифікація: ключ API (заголовок x-api-key або параметр запиту api_key).
| Параметр | Тип | Обов'язковий | Примітки |
|---|---|---|---|
websiteId | uuid | так | Має бути дійсним UUID. Для цієї кінцевої точки немає резервного Host чи конфігурації. |
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 — відсутній або недійсний websiteId401 — недійсний ключ API