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

SnelstartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetHaal gegenereerde blokken opgetGET /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}

Haal de volledige velddefinitie van één aangepaste component op op basis van de naam.

Haal de volledige definitie van één aangepaste component op aan de hand van de naam, inclusief de lijst met velden.

Auth: API-sleutel (x-api-key-header of api_key-queryparameter).

Padparameters

ParameterTypeVereistOpmerkingen
namestringjaDe schemanaam, bijvoorbeeld post.

Queryparameters

ParameterTypeVereistOpmerkingen
websiteIduuidjaMoet een geldige UUID zijn.
api_keystringneeAlternatief voor de x-api-key-header.

Respons

{
  "id": "...",
  "name": "post",
  "displayName": "Bericht",
  "description": "Een documentatiebericht",
  "category": "Aangepast",
  "titleField": "titel",
  "routeSlugField": "titel",
  "icon": null,
  "fields": [
    { "name": "titel", "type": "string", "required": true }
  ],
  "slugFields": ["titel", "beschrijving"],
  "version": 8
}

slugFields wordt berekend — de namen van alle velden van het type string.

Voorbeeld

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

Fouten

  • 400 — ontbrekende of ongeldige websiteId
  • 401 — ongeldige API-sleutel
  • 404 — schema niet gevonden
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›