profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Параметрична маршрутизаціяTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyСкрипти у конструкторі шаблонівProject ScaffoldingMedia Library

Headless

Швидкий стартSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Огляд REST APIgetПідключення вебсайту до APIgetGET /routesgetGET /routegetGET /blocksgetотримати-блоки-з-CEL-кешемgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postПереклад публікаційpatchОновлення перекладівgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /dataset/{schema_name}

Отримайте опубліковані документи для схеми — усі, один, пакет або сторінку — у вигляді потокового масиву JSON.

Отримайте опубліковані документи для схеми — усі, один документ, пакет за ідентифікаторами або сторінку — у вигляді потокового масиву JSON. Також доступно за адресою /schemas/{schema_name}. Посилання на зображення перетворюються на URL, а коли встановлено language, відповідний переклад накладається на базовий контент.

Автентифікація: ключ API. Ключ потрібен лише тоді, коли сервер встановлює require_schema_api_key = true; інакше дозволені анонімні запити на читання.

Параметри шляху

ПараметрТипОбов'язковийПримітки
schema_namestringтакСхема документа, наприклад post.

Параметри запиту

ПараметрТипОбов'язковийПримітки
websiteIduuidніЦільовий вебсайт; за замовчуванням використовує заголовок Host або конфігурацію.
iduuidніОтримайте один документ. Має пріоритет над ids.
idsstringніUUID, розділені комами (пакет, максимум 200). Має пріоритет над пагінацією.
languagestringніЗлиття перекладу для цієї локалі поверх базового контенту.
limitintegerніРозмір сторінки, значення за замовчуванням 200, обмеження 200.
offsetintegerніКількість рядків для пропуску (застосовується лише з додатним лімітом).
api_keystringніАльтернатива заголовку x-api-key.

Коли не вказано ні id, ні ids, документи повертаються у порядку published_at DESC.

Відповідь

Потоковий масив JSON. Кожен елемент містить опублікований вміст документа на верхньому рівні, а також додані ключі _id, _title та _publishedAt:

[
  {
    "_id": "...",
    "_title": "Початок роботи",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Початок роботи",
    "description": "...",
    "content": "..."
  }
]

Поля контенту мають пріоритет над доданими ключами у разі конфлікту. Посилання на зображення вигляду { alt, _asset: { id } } отримують розв’язаний url, доданий до _asset.

Приклад

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

Помилки

  • 400 — недійсний websiteId, недійсний id або некоректні ids (порожні, понад 200 або з недійсним UUID)
  • 401 — недійсний ключ API (або відсутній, коли потрібен)
  • 500 — збій запиту
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›