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 ScaffoldingBiblioteca multimedia

Sin interfaz

Inicio rápidojson y código de ClaudeComponent Zod Pull

Api rest

Visión general de la 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}postTraducción de publicacionespatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /dataset/{schema_name}

Obtén documentos publicados para un esquema — todos, uno, un lote o una página — como un arreglo JSON transmitido.

Obtén documentos publicados para un esquema — todos, un único documento, un lote por ID o una página — transmitidos como un arreglo JSON. También disponible en /schemas/{schema_name}. Las referencias de imágenes se resuelven a URL y, cuando se establece language, la traducción correspondiente se fusiona con el contenido base.

Auth: Clave de API. Solo se requiere una clave cuando el servidor establece require_schema_api_key = true; de lo contrario, se permiten lecturas anónimas.

Parámetros de ruta

ParámetroTipoObligatorioNotas
schema_namestringsíEl esquema del documento, p. ej. post.

Parámetros de consulta

ParámetroTipoObligatorioNotas
websiteIduuidnoSitio web de destino; recurre al encabezado/configuración Host.
iduuidnoObtiene un solo documento. Tiene prioridad sobre ids.
idsstringnoUUID separados por comas (lote, máx. 200). Tiene prioridad sobre la paginación.
languagestringnoFusiona la traducción para esta configuración regional con el contenido base.
limitintegernoTamaño de página, predeterminado 200, con límite superior de 200.
offsetintegernoFilas que omitir (solo se aplica con un límite positivo).
api_keystringnoAlternativa al encabezado x-api-key.

Cuando no se establece ni id ni ids, los documentos se devuelven ordenados por published_at DESC.

Respuesta

Un arreglo JSON transmitido. Cada elemento es el contenido publicado del documento expandido en el nivel superior, más las claves inyectadas _id, _title y _publishedAt:

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

Los campos de contenido tienen prioridad sobre las claves inyectadas en caso de colisión. Las referencias de imagen con la forma { alt, _asset: { id } } reciben un url resuelto inyectado en _asset.

Ejemplo

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

Errores

  • 400 — websiteId inválido, id inválido o ids incorrecto (vacío, más de 200 o un UUID inválido)
  • 401 — clave de API inválida (o ausente cuando es requerida)
  • 500 — error en la consulta
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›