profound-logoProfound CMS
⌘K
Admin
Theme
DocsGuidaBlogPhilosophy
DocsGuidaBlogPhilosophy

Hybrid

Instradamento parametricoTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Senza testa

Guida rapidaSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetOttieni percorsogetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components

Elenca i riepiloghi dei componenti personalizzati (schema di tipo di contenuto) di un sito web.

Elenca i riepiloghi dei componenti personalizzati (schema di tipo di contenuto) per un sito web, ordinati per nome. Vengono restituiti solo gli schemi personalizzati definiti dall'utente.

Autenticazione: chiave API (intestazione x-api-key o parametro di query api_key).

Parametri di query

ParametroTipoObbligatorioNote
websiteIduuidsìDeve essere un UUID valido. Nessun fallback Host/config per questo endpoint.
statestringnoFiltra per stato del ciclo di vita: draft, active o archived.
api_keystringnoAlternativa all'intestazione x-api-key.

Risposta

Un array JSON di riepiloghi di componenti:

[
  {
    "id": "...",
    "name": "post",
    "displayName": "Post",
    "description": "Un post di documentazione",
    "category": "Custom",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "custom",
    "version": 8,
    "routeSlugField": "title"
  }
]

source è sempre "custom". displayName torna a name e category assume il valore predefinito "Custom" quando non è impostato.

Esempio

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

Errori

  • 400 — websiteId mancante o non valido
  • 401 — chiave API non valida
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›