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 ScaffoldingBibliotecă media

Fără interfață

Pornire rapidăSplit Screen JSON Component Builder with LLMComponent Zod Pull

API REST

Prezentare generală API RESTgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetObține blocuri cu cache CELgetGET /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

Listați rutele unui site web, paginate, cu ID-uri de bloc efective.

Listați rutele unui site web, paginate și opțional filtrate după stare și tipar. Rutele cu block_ids goale sunt completate din ruta dinamică implicită corespunzătoare, astfel încât block_ids returnate sunt blocurile efective care trebuie randate.

Autentificare: Cheie API (x-api-key header sau parametrul de interogare api_key).

Parametri de interogare

ParametruTipObligatoriuNote
websiteIduuiddaSite web țintă.
api_keystringnuAlternativă la antetul x-api-key.
statestringnuFiltrare după starea rutei (potrivire exactă).
patternstringnuPotrivire de subșir pe tiparul rutei (LIKE, caracterele wildcard sunt escapate).
limitintegernuDimensiunea paginii, implicit 50, limitată la 1–100.
offsetintegernuRânduri de omis, implicit 0.

Rezultatele sunt ordonate după updated_at DESC.

Răspuns

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Noțiuni introductive",
      "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 reprezintă numărul total după filtrare; hasMore este offset + limit < total. label, param_bindings, template_block_ids și override_mode sunt omise sau null atunci când nu sunt setate.

Exemplu

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

Erori

  • 400 — websiteId lipsă sau invalid
  • 401 — cheie API invalidă (sau lipsește când serverul necesită una)
Continue Reading
Previous‹Connect your websiteNextGET /route›