profound-logoProfound CMS
⌘K
Admin
Theme
DokumentaceTutorialBlogPhilosophy
DokumentaceTutorialBlogPhilosophy

Hybrid

Parametrické směrováníTypes of ComponentsSetup server sent events (SSE) content refetchNastavení proxy administračního paneluCEL Scripting in Template BuilderProject ScaffoldingKnihovna médií

Headless

Rychlý startJson a claude kódComponent Zod Pull

rozhraní REST API

REST API OverviewgetPřipojení webu k API CMSgetGET /routesgetGET /routegetGET /blocksgetzískat bloky s mezipamětí CELgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPřeklad po publikacipatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /routes

Vypíše trasy webu, stránkované, s efektivními identifikátory bloků.

Vypíše trasy webu, stránkované a volitelně filtrované podle stavu a vzoru. Trasy s prázdným block_ids jsou doplněny z odpovídající dynamické výchozí trasy, takže vrácené block_ids představují efektivní bloky k vykreslení.

Autorizace: API klíč (hlavička x-api-key nebo dotazovací parametr api_key).

Parametry dotazu

ParametrTypPovinnéPoznámky
websiteIduuidanoCílový web.
api_keystringneAlternativa k hlavičce x-api-key.
statestringneFiltrovat podle stavu trasy (přesná shoda).
patternstringnePorovnání podřetězce ve vzoru trasy (LIKE, zástupné znaky jsou escapovány).
limitintegerneVelikost stránky, výchozí hodnota 50, omezeno na 1–100.
offsetintegernePočet přeskočených řádků, výchozí hodnota 0.

Výsledky jsou seřazeny podle updated_at DESC.

Odpověď

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Začínáme",
      "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 je úplný počet po filtrování; hasMore je offset + limit < total. label, param_bindings, template_block_ids a override_mode jsou vynechány nebo mají hodnotu null, pokud nejsou nastaveny.

Příklad

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

Chyby

  • 400 — chybějící nebo neplatný websiteId
  • 401 — neplatný API klíč (nebo chybějící, pokud ho server vyžaduje)
Continue Reading
Previous‹Připojení webu k API CMSNextGET /route›