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 ScaffoldingMedia Library

Headless

Quick startSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API 概要getウェブサイトを CMS API に接続するgetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostCSV 投稿patchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /routes

ページネーション付きで、描画に用いる有効なブロックIDとともにウェブサイトのルートを一覧表示します。

ウェブサイトのルートを一覧表示し、ページネーションを行い、状態とパターンで任意にフィルターします。空の block_ids を持つルートは、対応する dynamic-default ルートから補完されるため、返される 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 の場合に true となります。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‹ウェブサイトを CMS API に接続するNextGET /route›