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 proxySkripting i malbyggerenProject 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}postEtteroversettelsepatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components

List opp et nettsteds sammendrag av tilpassede komponenter (innholdstypeskjemaer).

List opp sammendrag av tilpassede komponenter (innholdstypeskjemaer) for et nettsted, sortert etter navn. Bare brukerdefinerte, tilpassede skjemaer returneres.

Autentisering: API-nĂžkkel (x-api-key-header eller api_key-spĂžrringsparameter).

ForespĂžrselsparametere

ParameterTypePÄkrevdMerknader
websiteIduuidjaMÄ vÊre en gyldig UUID. Ingen Host-/konfigurasjonsreserve pÄ dette endepunktet.
statestringneiFiltrer etter livssyklusstatus: draft, active eller archived.
api_keystringneiAlternativ til x-api-key-headeren.

Respons

Et JSON-array med komponentsammendrag:

[
  {
    "id": "...",
    "name": "innlegg",
    "displayName": "Innlegg",
    "description": "Et dokumentasjonsinnlegg",
    "category": "Tilpasset",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "tilpasset",
    "version": 8,
    "routeSlugField": "tittel"
  }
]

source er alltid "custom". displayName faller tilbake til name, og category fÄr standardverdien "Custom" nÄr den ikke er satt.

Eksempel

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

Feil

  • 400 — manglende eller ugyldig websiteId
  • 401 — ugyldig API-nĂžkkel
Continue Reading
Previousâ€čGET /blocks/generatedNextGET /components/{name}â€ș