GET /dataset/{schema_name}

Получение опубликованных документов для схемы — всех, одного, пакета или страницы — в виде потокового массива JSON.

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

Аутентификация: ключ API. Ключ требуется только тогда, когда сервер устанавливает require_schema_api_key = true; иначе допускаются анонимные чтения.

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

Параметр	Тип	Обязательный	Примечания
`schema_name`	string	да	Схема документа, например `post`.

Параметры запроса

Параметр	Тип	Обязательный	Примечания
`websiteId`	uuid	нет	Целевой веб-сайт; при отсутствии используется заголовок `Host` / конфигурация.
`id`	uuid	нет	Получить один документ. Имеет приоритет над `ids`.
`ids`	string	нет	UUID, разделённые запятыми (пакет, максимум 200). Имеет приоритет над пагинацией.
`language`	string	нет	Наложить перевод для этой локали поверх базового содержимого.
`limit`	integer	нет	Размер страницы, значение по умолчанию — `200`, верхний предел — `200`.
`offset`	integer	нет	Количество пропускаемых строк (применяется только при положительном пределе).
`api_key`	string	нет	Альтернатива заголовку `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 } } в _asset добавляется вычисленный url.

Пример

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

Ошибки

400 — недействительный websiteId, недействительный id или некорректный ids (пустой, более 200 или недопустимый UUID)
401 — недействительный ключ API (или отсутствует, когда требуется)
500 — ошибка запроса

Previous‹GET /components/{name}NextGET /content-changes (SSE)›