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 proxyScripts dans le générateur de modèlesProject ScaffoldingBibliothèque multimédia

Sans interface

Démarrage rapideSplit Screen JSON Component Builder with LLMComponent Zod Pull

API REST

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

Répertorie les routes d'un site web, paginées, avec des identifiants de blocs effectifs.

Répertorie les routes d'un site web, paginées et éventuellement filtrées par état et motif. Les routes dont block_ids est vide sont complétées à partir de la route dynamique par défaut correspondante, de sorte que les block_ids renvoyés sont les blocs effectifs à rendre.

Authentification : Clé API (en-tête x-api-key ou paramètre de requête api_key).

Paramètres de requête

ParamètreTypeObligatoireRemarques
websiteIduuidouiSite web cible.
api_keychaînenonAlternative à l'en-tête x-api-key.
statechaînenonFiltrer par état de la route (correspondance exacte).
patternchaînenonCorrespondance de sous-chaîne sur le motif de la route (LIKE, caractères génériques échappés).
limitentiernonTaille de page, valeur par défaut 50, bornée entre 1 et 100.
offsetentiernonLignes à ignorer, valeur par défaut 0.

Les résultats sont triés par updated_at DESC.

Réponse

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Prise en main",
      "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 correspond au nombre total filtré ; hasMore vaut offset + limit < total. label, param_bindings, template_block_ids et override_mode sont omis ou null lorsqu'ils ne sont pas définis.

Exemple

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

Erreurs

  • 400 — websiteId manquant ou invalide
  • 401 — Clé API invalide (ou absente lorsque le serveur en exige une)
Continue Reading
Previous‹Connect your websiteNextGET /route›