GET /components/{name}

Buscar a definição completa de campos de um único componente personalizado pelo nome.

Buscar a definição completa de um único componente personalizado pelo nome, incluindo sua lista de campos.

Auth: Chave de API (cabeçalho x-api-key ou parâmetro de consulta api_key).

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Notas
`name`	string	sim	O nome do esquema, por exemplo `postagem`.

Parâmetros de consulta

Parâmetro	Tipo	Obrigatório	Notas
`websiteId`	uuid	sim	Deve ser um UUID válido.
`api_key`	string	não	Alternativa ao cabeçalho `x-api-key`.

Resposta

{
  "id": "...",
  "name": "postagem",
  "displayName": "Postagem",
  "description": "Uma postagem de documentação",
  "category": "Personalizado",
  "titleField": "titulo",
  "routeSlugField": "titulo",
  "icon": null,
  "fields": [
    { "name": "titulo", "type": "string", "required": true }
  ],
  "slugFields": ["titulo", "descricao"],
  "version": 8
}

slugFields é calculado — os nomes de todos os campos do tipo string.

Exemplo

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

Erros

400 — websiteId ausente ou inválido
401 — chave de API inválida
404 — esquema não encontrado

Previous‹GET /components NextGET /dataset/{schema_name}›