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

Enumera los resúmenes de componentes personalizados (esquemas de tipo de contenido) de un sitio web.

Enumera los resúmenes de componentes personalizados (esquemas de tipo de contenido) de un sitio web, ordenados por nombre. Solo se devuelven los esquemas personalizados definidos por el usuario.

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

Parámetros de consulta

ParámetroTipoObligatorioNotas
websiteIduuidsíDebe ser un UUID válido. No hay respaldo de Host/config en este endpoint.
statestringnoFiltra por estado del ciclo de vida: draft, active o archived.
api_keystringnoAlternativa al encabezado x-api-key.

Respuesta

Una matriz JSON de resúmenes de componentes:

[
  {
    "id": "...",
    "name": "publicacion",
    "displayName": "Publicación",
    "description": "Una publicación de documentación",
    "category": "Personalizado",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "personalizado",
    "version": 8,
    "routeSlugField": "título"
  }
]

source siempre es "custom". displayName recurre a name, y category toma el valor predeterminado "Custom" cuando no se establece.

Ejemplo

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

Errores

  • 400 — websiteId ausente o no válido
  • 401 — clave de API no válida
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›