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 ScaffoldingMedia Library

Headless

SnelstartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetHaal gegenereerde blokken opgetGET /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

Toon overzichten van de aangepaste componenten (inhoudstypeschema) van een website.

Geef overzichten van aangepaste componenten (inhoudstypeschema) voor een website, gesorteerd op naam. Alleen door gebruikers gedefinieerde aangepaste schema's worden teruggegeven.

Authenticatie: API-sleutel (x-api-key-header of api_key-queryparameter).

Queryparameters

ParameterTypeVereistOpmerkingen
websiteIduuidjaMoet een geldige UUID zijn. Geen Host-/config-fallback op dit endpoint.
statestringneeFilter op levenscyclusstatus: draft, active of archived.
api_keystringneeAlternatief voor de x-api-key-header.

Antwoord

Een JSON-array met componentoverzichten:

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

source is altijd "custom". displayName valt terug op name, en category gebruikt standaard "Custom" wanneer niet ingesteld.

Voorbeeld

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

Fouten

  • 400 — ontbrekende of ongeldige websiteId
  • 401 — ongeldige API-sleutel
Continue Reading
Previous‹Haal gegenereerde blokken opNextGET /components/{name}›