Перелічує маршрути вебсайту з розбиттям на сторінки, із фактичними ідентифікаторами блоків.
Перелічує маршрути вебсайту з розбиттям на сторінки та, за потреби, фільтрацією за станом і шаблоном. Маршрути з порожніми block_ids доповнюються зіставленим маршрутом dynamic-default, тому повернені block_ids — це фактичні блоки для відображення.
Автентифікація: ключ API (заголовок x-api-key або параметр запиту api_key).
| Параметр | Тип | Обов'язково | Примітки |
|---|---|---|---|
websiteId | uuid | так | Цільовий вебсайт. |
api_key | string | ні | Альтернатива заголовку x-api-key. |
state | string | ні | Фільтр за станом маршруту (точна відповідність). |
pattern | string | ні | Пошук підрядка у шаблоні маршруту (LIKE, символи-замінники екрануються). |
limit | integer | ні | Розмір сторінки, типове значення 50, обмежено до 1–100. |
offset | integer | ні | Кількість рядків для пропуску, типове значення 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 — відсутній або некоректний websiteId401 — недійсний ключ API (або відсутній, якщо сервер вимагає його)