Liste as rotas de um site, paginadas, com IDs de blocos efetivos.
Liste as rotas de um site, paginadas e opcionalmente filtradas por estado e padrão. Rotas com block_ids vazios são preenchidas a partir da rota dinâmica padrão correspondente, portanto os block_ids retornados são os blocos efetivos a serem renderizados.
Auth: Chave de API (cabeçalho x-api-key ou parâmetro de consulta api_key).
| Parâmetro | Tipo | Obrigatório | Observações |
|---|---|---|---|
websiteId | uuid | sim | Site de destino. |
api_key | string | não | Alternativa ao cabeçalho x-api-key. |
state | string | não | Filtra pelo estado da rota (correspondência exata). |
pattern | string | não | Correspondência de substring no padrão da rota (LIKE, curingas escapados). |
limit | integer | não | Tamanho da página, padrão 50, limitado a 1–100. |
offset | integer | não | Linhas a ignorar, padrão 0. |
Os resultados são ordenados por updated_at DESC.
{
"routes": [
{
"website_id": "...",
"path": "/docs/primeiros-passos",
"pattern": "/docs/primeiros-passos",
"label": "Primeiros Passos",
"tags": [],
"block_ids": ["..."],
"template_block_ids": ["..."],
"override_mode": "mesclar",
"state": "Publicada",
"param_bindings": {},
"created_at": "2026-06-23T18:34:16Z",
"updated_at": "2026-06-23T20:36:55Z"
}
],
"total": 42,
"hasMore": true
}
total é a contagem total filtrada; hasMore é offset + limit < total. label, param_bindings, template_block_ids e override_mode são omitidos ou null quando não definidos.
curl '{CMS_API_URL}/routes?websiteId=<uuid>&limit=20' \
-H 'x-api-key: <key>'
400 — websiteId ausente ou inválido401 — chave de API inválida (ou ausente quando o servidor exige uma)