profound-logoProfound CMS
⌘K
Admin
Theme
Tài liệuHướng dẫnBlogTriết học
Tài liệuHướng dẫnBlogTriết học

Kết hợp

Định tuyến tham sốCác loại ComponentSetup server sent events (SSE) content refetchThiết lập proxy bảng điều khiển quản trịCEL Scripting in Template BuilderProject ScaffoldingThư viện phương tiện

Không đầu

Bắt đầu nhanhJson và claude codeComponent Zod Pull

REST API

Tổng quan REST APIgetKết nối API trang webgetGET /routesgetLấy tuyếngetGET /blocksgetLấy các khối kèm bộ đệm CELgetGET /blocks/generatedgetGET /componentsgetLấy tên thành phầngetLấy tên lược đồ tập dữ liệugetGET /content-changes (SSE)patchCập nhật tên lược đồ tập dữ liệupostPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /routes

Liệt kê các tuyến của một trang web, phân trang, với các block ID có hiệu lực.

Liệt kê các tuyến của một trang web, phân trang và tùy chọn lọc theo trạng thái và mẫu. Các tuyến có block_ids trống được điền từ tuyến dynamic-default tương ứng, vì vậy các block_ids được trả về là các khối có hiệu lực để kết xuất.

Xác thực: Khóa API (header x-api-key hoặc tham số truy vấn api_key).

Tham số truy vấn

Tham sốKiểuBắt buộcGhi chú
websiteIduuidcóTrang web mục tiêu.
api_keystringkhôngLựa chọn thay thế cho header x-api-key.
statestringkhôngLọc theo trạng thái của tuyến (khớp chính xác).
patternstringkhôngKhớp chuỗi con trên mẫu tuyến (LIKE, ký tự đại diện đã được escape).
limitintegerkhôngKích thước trang, mặc định 50, giới hạn trong khoảng 1–100.
offsetintegerkhôngSố hàng bỏ qua, mặc định 0.

Kết quả được sắp xếp theo updated_at DESC.

Phản hồi

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Bắt đầu",
      "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 là tổng số sau khi lọc; hasMore là offset + limit < total. label, param_bindings, template_block_ids và override_mode được lược bỏ hoặc bằng null khi chưa được thiết lập.

Ví dụ

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

Lỗi

  • 400 — thiếu hoặc websiteId không hợp lệ
  • 401 — khóa API không hợp lệ (hoặc thiếu khi máy chủ yêu cầu)
Continue Reading
Previous‹Kết nối API trang webNextLấy tuyến›