profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingBiblioteca multimedia

Sin interfaz

Inicio rápidojson y código de ClaudeComponent Zod Pull

Api rest

Visión general de la API RESTgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postTraducción de publicacionespatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components/{name}

Obtén la definición completa de campos de un componente personalizado por nombre.

Obtén la definición completa de un componente personalizado individual por nombre, incluida su lista de campos.

Auth: Clave de API (encabezado x-api-key o parámetro de consulta api_key).

Parámetros de ruta

ParámetroTipoObligatorioNotas
namestringsíEl nombre del esquema, p. ej., post.

Parámetros de consulta

ParámetroTipoObligatorioNotas
websiteIduuidsíDebe ser un UUID válido.
api_keystringnoAlternativa al encabezado x-api-key.

Respuesta

{
  "id": "...",
  "name": "post",
  "displayName": "Post",
  "description": "A documentation Post",
  "category": "Custom",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields se calcula: los nombres de todos los campos de tipo cadena.

Ejemplo

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

Errores

  • 400 — websiteId ausente o no válido
  • 401 — clave de API no válida
  • 404 — esquema no encontrado
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›