profound-logoProfound CMS
⌘K
Admin
Theme
DokumenteTutorialBlogPhilosophie
DokumenteTutorialBlogPhilosophie

Hybrid

Parametrisches RoutingKomponenten-TypenSetup server sent events (SSE) content refetchEinrichtung-Admin-Panel-ProxyScripting im Template-BuilderProject ScaffoldingMedienbibliothek

Headless

SchnellstartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST-API

REST API OverviewgetWebsite mit der CMS-API verbindengetRouten abrufengetRoute abrufengetBlöcke abrufengetBlöcke mit CEL-Cache abrufengetGET /blocks/generatedgetKomponenten abrufengetKomponentenname abrufengetGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postNachbearbeitung der ÜbersetzungpatchPatch-ÜbersetzungengetNutzung abrufenpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Komponenten abrufen

Listet die Zusammenfassungen der benutzerdefinierten Komponenten (Content-Type-Schemas) einer Website auf.

Listet Zusammenfassungen benutzerdefinierter Komponenten (Content-Type-Schemas) für eine Website auf, sortiert nach Namen. Es werden nur benutzerdefinierte Schemas von Nutzern zurückgegeben.

Auth: API-Schlüssel (x-api-key-Header oder api_key-Query-Parameter).

Abfrageparameter

ParameterTypErforderlichHinweise
websiteIduuidjaMuss eine gültige UUID sein. Kein Host-/Konfig-Fallback für diesen Endpunkt.
statestringneinFiltert nach Lebenszyklusstatus: draft, active oder archived.
api_keystringneinAlternative zum x-api-key-Header.

Antwort

Ein JSON-Array mit Komponenten-Zusammenfassungen:

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

source ist immer "custom". displayName fällt auf name zurück und category hat standardmäßig den Wert "Custom", wenn nichts gesetzt ist.

Beispiel

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

Fehler

  • 400 — fehlende oder ungültige websiteId
  • 401 — ungültiger API-Schlüssel
Continue Reading
Previous‹GET /blocks/generatedNextKomponentenname abrufen›