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/{name}

Hent den fullstendige feltdefinisjonen for en enkelt egendefinert komponent etter navn.

Hent den fullstendige definisjonen av en enkelt egendefinert komponent etter navn, inkludert feltlisten.

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

Sti-parametere

ParameterTypePÄkrevdMerknader
namestringjaSkjemaets navn, f.eks. post.

SpĂžrringsparametere

ParameterTypePÄkrevdMerknader
websiteIduuidjaMĂ„ vĂŠre en gyldig UUID.
api_keystringneiAlternativ til x-api-key-headeren.

Respons

{
  "id": "...",
  "name": "post",
  "displayName": "Post",
  "description": "Et dokumentasjonsinnlegg",
  "category": "Egendefinert",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields beregnes — navnene pĂ„ alle felt av typen string.

Eksempel

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

Feil

  • 400 — mangler eller ugyldig websiteId
  • 401 — ugyldig API-nĂžkkel
  • 404 — skjema ikke funnet
Continue Reading
Previousâ€čGET /componentsNextGET /dataset/{schema_name}â€ș