Listar os resumos de componentes personalizados (esquemas de tipo de conteúdo) de um site.
Liste resumos de componentes personalizados (esquemas de tipo de conteúdo) para um site, ordenados por nome. Apenas esquemas personalizados definidos pelo usuário são retornados.
Autenticação: Chave de API (cabeçalho x-api-key ou parâmetro de consulta api_key).
| Parâmetro | Tipo | Obrigatório | Observações |
|---|---|---|---|
websiteId | uuid | sim | Deve ser um UUID válido. Não há fallback de Host/config neste endpoint. |
state | string | não | Filtra pelo estado do ciclo de vida: draft, active ou archived. |
api_key | string | não | Alternativa ao cabeçalho x-api-key. |
Um array JSON de resumos de componentes:
[
{
"id": "...",
"name": "post",
"displayName": "Post",
"description": "A documentation Post",
"category": "Custom",
"tags": [],
"fields": [],
"icon": null,
"source": "custom",
"version": 8,
"routeSlugField": "title"
}
]
source é sempre "custom". displayName recorre a name, e category assume o padrão "Custom" quando não definido.
curl '{CMS_API_URL}/components?websiteId=<uuid>&state=active' \
-H 'x-api-key: <key>'
400 — websiteId ausente ou inválido401 — Chave de API inválida