profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsKomponenttyperSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyScripting i skabelonbyggerenProject ScaffoldingMediebibliotek

Headless

HurtigstartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API-oversigtgetConnect 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

Oplist resuméer af et websites brugerdefinerede komponenter (indholdstypeskemaer).

Oplist resuméer af brugerdefinerede komponenter (indholdstypeskemaer) for et website, sorteret efter navn. Kun brugerdefinerede skemaer, som brugeren har oprettet, returneres.

Godkendelse: API-nøgle (x-api-key-header eller api_key-forespørgselsparameter).

Forespørgselsparametre

ParameterTypePåkrævetBemærkninger
websiteIduuidjaSkal være en gyldig UUID. Ingen Host-/konfigurations-fallback på dette endepunkt.
statestringnejFiltrér efter livscyklusstatus: draft, active eller archived.
api_keystringnejAlternativ til x-api-key-headeren.

Svar

Et JSON-array med komponentresuméer:

[
  {
    "id": "...",
    "name": "post",
    "displayName": "Indlæg",
    "description": "Et dokumentationsindlæg",
    "category": "Brugerdefineret",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "custom",
    "version": 8,
    "routeSlugField": "title"
  }
]

source er altid "custom". displayName falder tilbage til name, og category har standardværdien "Custom", når den ikke er angivet.

Eksempel

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

Fejl

  • 400 — manglende eller ugyldig websiteId
  • 401 — ugyldig API-nøgle
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›