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 ScaffoldingBiblioteca multimedia

Sin interfaz

Inicio rápidojson y código de ClaudeComponent Zod Pull

Api rest

Visión general de la API RESTgetConnect 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}postTraducción de publicacionespatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /routes

Enumera las rutas de un sitio web, paginadas, con ID de bloques efectivos.

Enumera las rutas de un sitio web, paginadas y opcionalmente filtradas por estado y patrón. Las rutas con block_ids vacíos se completan a partir de la ruta dinámica predeterminada coincidente, por lo que los block_ids devueltos son los bloques efectivos que se deben renderizar.

Autenticación: Clave de API (encabezado x-api-key o parámetro de consulta api_key).

Parámetros de consulta

ParámetroTipoObligatorioNotas
websiteIduuidsíSitio web de destino.
api_keystringnoAlternativa al encabezado x-api-key.
statestringnoFiltrar por el estado de la ruta (coincidencia exacta).
patternstringnoCoincidencia de subcadena en el patrón de la ruta (LIKE, comodines escapados).
limitintegernoTamaño de página, valor predeterminado 50, limitado a 1–100.
offsetintegernoFilas que se omiten, valor predeterminado 0.

Los resultados se ordenan por updated_at DESC.

Respuesta

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

total es el recuento filtrado completo; hasMore es offset + limit < total. label, param_bindings, template_block_ids y override_mode se omiten o son null cuando no están establecidos.

Ejemplo

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

Errores

  • 400 — falta o es inválido websiteId
  • 401 — clave de API inválida (o ausente cuando el servidor requiere una)
Continue Reading
Previous‹Connect your websiteNextGET /route›