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

HÀmta en enskild anpassad komponents kompletta fÀltdefinition efter namn.

HÀmta en enskild anpassad komponents fullstÀndiga definition efter namn, inklusive dess fÀltlista.

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

SökvÀgsparametrar

ParameterTypObligatoriskAnmÀrkningar
namestrÀngjaSchemanamnet, t.ex. post.

FrÄgeparametrar

ParameterTypObligatoriskAnmÀrkningar
websiteIduuidjaMÄste vara ett giltigt UUID.
api_keystrÀngnejAlternativ till x-api-key-huvudet.

Svar

{
  "id": "...",
  "name": "inlÀgg",
  "displayName": "InlÀgg",
  "description": "Ett dokumentationsinlÀgg",
  "category": "Anpassad",
  "titleField": "titel",
  "routeSlugField": "titel",
  "icon": null,
  "fields": [
    { "name": "titel", "type": "strÀng", "required": true }
  ],
  "slugFields": ["titel", "beskrivning"],
  "version": 8
}

slugFields berĂ€knas – namnen pĂ„ alla strĂ€ngtypade fĂ€lt.

Exempel

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

Fel

  • 400 — saknad eller ogiltig websiteId
  • 401 — ogiltig API-nyckel
  • 404 — schema hittades inte
Continue Reading
Previousâ€čGET /componentsNextGET /dataset/{schema_name}â€ș