Получить компоненты

Перечисляет краткие сведения о пользовательских компонентах (схемах типа содержимого) веб-сайта.

Перечисляет краткие сведения о пользовательских компонентах (схемах типа содержимого) для веб-сайта, упорядоченные по имени. Возвращаются только пользовательские схемы, созданные пользователем.

Аутентификация: ключ 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 — отсутствующий или недопустимый websiteId
401 — недействительный ключ API

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

Параметры запроса

Параметр

Тип

Обязательный

Примечания

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"
  }
]