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

Quick startSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect 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}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components

Lista en webbplats sammanfattningar av anpassade komponenter (innehÄllstypsscheman).

Lista sammanfattningar av anpassade komponenter (innehÄllstypsscheman) för en webbplats, sorterade efter namn. Endast anvÀndardefinierade anpassade scheman returneras.

Autentisering: API-nyckel (x-api-key-huvud eller api_key-frÄgeparameter).

FrÄgeparametrar

ParameterTypObligatoriskKommentarer
websiteIduuidjaMÄste vara en giltig UUID. Ingen ÄtergÄng till Host/konfiguration pÄ denna slutpunkt.
statestringnejFiltrera efter livscykelstatus: draft, active eller archived.
api_keystringnejAlternativ till x-api-key-huvudet.

Svar

En JSON-array med komponentsammanfattningar:

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

source Àr alltid "custom". displayName ÄtergÄr till name, och category har standardvÀrdet "Custom" nÀr det inte Àr angivet.

Exempel

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

Fel

  • 400 — saknad eller ogiltig websiteId
  • 401 — ogiltig API-nyckel
Continue Reading
Previousâ€čGET /blocks/generatedNextGET /components/{name}â€ș