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 /routes

Toon de routes van een website, gepagineerd, met effectieve blok-ID's.

Geef de routes van een website weer, gepagineerd en optioneel gefilterd op status en patroon. Routes met lege block_ids worden aangevuld vanuit de overeenkomende dynamische standaardroute, waardoor de geretourneerde block_ids de effectieve blokken zijn om te renderen.

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

Queryparameters

ParameterTypeVereistOpmerkingen
websiteIduuidjaDoelwebsite.
api_keystringneeAlternatief voor de x-api-key-header.
statestringneeFilter op routestatus (exacte overeenkomst).
patternstringneeDeels overeenkomend met het routepatroon (LIKE, jokertekens worden geëscaped).
limitintegerneePaginagrootte, standaard 50, begrensd tot 1–100.
offsetintegerneeAantal over te slaan rijen, standaard 0.

Resultaten worden gesorteerd op updated_at DESC.

Antwoord

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Aan de slag",
      "tags": [],
      "block_ids": ["..."],
      "template_block_ids": ["..."],
      "override_mode": "merge",
      "state": "Live",
      "param_bindings": {},
      "created_at": "2026-06-23T18:34:16Z",
      "updated_at": "2026-06-23T20:36:55Z"
    }
  ],
  "total": 42,
  "hasMore": true
}

total is het volledige gefilterde aantal; hasMore is offset + limit < total. label, param_bindings, template_block_ids en override_mode worden weggelaten of zijn null wanneer ze niet zijn ingesteld.

Voorbeeld

curl '{CMS_API_URL}/routes?websiteId=<uuid>&limit=20' \
  -H 'x-api-key: <key>'

Fouten

  • 400 — ontbrekende of ongeldige websiteId
  • 401 — ongeldige API-sleutel (of ontbreekt wanneer de server er een vereist)
Continue Reading
Previous‹Connect your websiteNextGET /route›