profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialБлогPhilosophy
DocsTutorialБлогPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyНаписание скриптов в конструкторе шаблоновProject ScaffoldingМедиатека

Без интерфейса

Быстрый стартSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Обзор REST APIgetConnect your websitegetПолучить маршрутыgetGET /routegetПолучение блоковgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetПолучить компонентыgetGET /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

Получить маршруты

Выводит маршруты веб-сайта с пагинацией и фактическими идентификаторами блоков.

Отображает маршруты веб-сайта, разбитые на страницы и при необходимости отфильтрованные по состоянию и шаблону. Маршруты с пустыми block_ids дополняются из соответствующего динамического маршрута по умолчанию, поэтому возвращаемые block_ids — это фактические блоки для отображения.

Аутентификация: ключ API (x-api-key в заголовке или параметр запроса api_key).

Параметры запроса

ПараметрТипОбязательныйПримечания
websiteIduuidдаЦелевой веб-сайт.
api_keystringнетАльтернатива заголовку x-api-key.
statestringнетФильтр по состоянию маршрута (точное совпадение).
patternstringнетСравнение подстроки в шаблоне маршрута (LIKE, подстановочные знаки экранируются).
limitintegerнетРазмер страницы, по умолчанию 50, ограничен диапазоном 1–100.
offsetintegerнетКоличество пропускаемых строк, по умолчанию 0.

Результаты упорядочены по updated_at DESC.

Ответ

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Getting Started",
      "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 — это полное количество элементов после фильтрации; hasMore равно offset + limit < total. Поля label, param_bindings, template_block_ids и override_mode опущены или равны null, если не заданы.

Пример

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

Ошибки

  • 400 — отсутствует или недействительный websiteId
  • 401 — недействительный ключ API (или отсутствует, если сервер требует его)
Continue Reading
Previous‹Connect your websiteNextGET /route›