profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypy komponentówSetup server sent events (SSE) content refetchInstall Profound CMS as a proxySkrypty w kreatorze szablonówProject ScaffoldingBiblioteka multimediów

Headless

Szybki startSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Przegląd REST APIgetConnect 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}postTłumaczenie postapatchKorekty tłumaczeńgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /routes

Wyświetla listę tras witryny, stronicowaną, z efektywnymi identyfikatorami bloków.

Wyświetla listę tras witryny, stronicowaną i opcjonalnie filtrowaną według stanu oraz wzorca. Trasy z pustymi block_ids są uzupełniane na podstawie pasującej dynamicznej trasy domyślnej, więc zwracane block_ids to efektywne bloki do renderowania.

Uwierzytelnianie: Klucz API (nagłówek x-api-key lub parametr zapytania api_key).

Parametry zapytania

ParametrTypWymaganyUwagi
websiteIduuidtakDocelowa witryna.
api_keystringnieAlternatywa dla nagłówka x-api-key.
statestringnieFiltruj według stanu trasy (dokładne dopasowanie).
patternstringnieDopasowanie podciągu względem wzorca trasy (LIKE, znaki wieloznaczne są eskapowane).
limitintegernieRozmiar strony, domyślnie 50, ograniczony do zakresu 1–100.
offsetintegernieLiczba wierszy do pominięcia, domyślnie 0.

Wyniki są sortowane według updated_at DESC.

Odpowiedź

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Pierwsze kroki",
      "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 to pełna, przefiltrowana liczba rekordów; hasMore oznacza offset + limit < total. Pola label, param_bindings, template_block_ids i override_mode są pomijane lub mają wartość null, jeśli nie zostały ustawione.

Przykład

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

Błędy

  • 400 — brakujące lub nieprawidłowe websiteId
  • 401 — nieprawidłowy klucz API (lub brak, gdy serwer go wymaga)
Continue Reading
Previous‹Connect your websiteNextGET /route›