profound-logoProfound CMS
⌘K
Admin
Theme
DocsGuidaBlogPhilosophy
DocsGuidaBlogPhilosophy

Hybrid

Instradamento parametricoTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Senza testa

Guida rapidaSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetOttieni percorsogetGET /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

Elenca le route di un sito web, con paginazione, con gli ID di blocco effettivi.

Elenca le route di un sito web, con paginazione e, facoltativamente, filtrate per stato e pattern. Le route con block_ids vuoti vengono integrate a partire dalla route dynamic-default corrispondente, quindi i block_ids restituiti sono i blocchi effettivi da renderizzare.

Autenticazione: API key (intestazione x-api-key o parametro di query api_key).

Parametri di query

ParametroTipoObbligatorioNote
websiteIduuidsìSito web di destinazione.
api_keystringnoAlternativa all'intestazione x-api-key.
statestringnoFiltra per stato della route (corrispondenza esatta).
patternstringnoCorrispondenza di sottostringa sul pattern della route (LIKE, caratteri jolly con escape).
limitintegernoDimensione della pagina, predefinita 50, limitata da 1–100.
offsetintegernoRighe da saltare, predefinito 0.

I risultati sono ordinati per updated_at DESC.

Risposta

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Guida introduttiva",
      "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 è il conteggio totale filtrato; hasMore è offset + limit < total. label, param_bindings, template_block_ids e override_mode vengono omessi oppure impostati a null quando non definiti.

Esempio

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

Errori

  • 400 — websiteId mancante o non valido
  • 401 — API key non valida (o mancante quando il server la richiede)
Continue Reading
Previous‹Connect your websiteNextOttieni percorso›