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

Tanpa kepala

Mulai CepatSplit Screen JSON Component Builder with LLMPenarikan Komponen Zod

REST API

ikhtisar API RESTgetConnect 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}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /dataset/{schema_name}

Ambil dokumen yang dipublikasikan untuk sebuah skema — semuanya, satu, sekumpulan, atau satu halaman — sebagai array JSON yang dialirkan.

Ambil dokumen yang dipublikasikan untuk sebuah skema — semuanya, satu dokumen, sekumpulan berdasarkan ID, atau satu halaman — dialirkan sebagai array JSON. Juga tersedia di /schemas/{schema_name}. Referensi gambar diselesaikan menjadi URL, dan ketika language diatur, terjemahan yang cocok digabungkan di atas konten dasar.

Auth: Kunci API. Sebuah kunci hanya diperlukan ketika server menetapkan require_schema_api_key = true; jika tidak, pembacaan anonim diperbolehkan.

Parameter path

ParameterJenisWajibCatatan
schema_namestringyaSkema dokumen, mis. post.

Parameter kueri

ParameterJenisWajibCatatan
websiteIduuidtidakSitus web target; kembali ke header / konfigurasi Host.
iduuidtidakAmbil satu dokumen. Mengungguli ids.
idsstringtidakUUID yang dipisahkan koma (batch, maks 200). Mengungguli paginasi.
languagestringtidakGabungkan terjemahan untuk lokal ini di atas konten dasar.
limitintegertidakUkuran halaman, bawaan 200, dibatasi hingga 200.
offsetintegertidakJumlah baris untuk dilewati (hanya diterapkan dengan limit positif).
api_keystringtidakAlternatif untuk header x-api-key.

Ketika id maupun ids tidak diatur, dokumen dikembalikan dengan urutan published_at DESC.

Respons

Sebuah array JSON yang dialirkan. Setiap elemen adalah konten terbit dokumen yang diratakan di tingkat teratas, ditambah kunci yang disuntikkan _id, _title, dan _publishedAt:

[
  {
    "_id": "...",
    "_title": "Memulai",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Memulai",
    "description": "...",
    "content": "..."
  }
]

Kolom konten memenangkan atas kunci yang disuntikkan saat terjadi tabrakan. Referensi gambar dengan bentuk { alt, _asset: { id } } mendapatkan url yang diselesaikan dan disuntikkan ke _asset.

Contoh

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

Kesalahan

  • 400 — websiteId tidak valid, id tidak valid, atau ids buruk (kosong, lebih dari 200, atau UUID tidak valid)
  • 401 — kunci API tidak valid (atau hilang ketika diperlukan)
  • 500 — kueri gagal
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›