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 proxyScripts dans le générateur de modèlesProject ScaffoldingBibliothèque multimédia

Sans interface

Démarrage rapideSplit Screen JSON Component Builder with LLMComponent Zod Pull

API REST

REST API OverviewgetConnect 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}

Récupère les documents publiés pour un schéma — tous, un seul, un lot ou une page — sous forme de tableau JSON diffusé.

Récupère les documents publiés pour un schéma — tous, un seul document, un lot par identifiants ou une page — diffusés en continu sous forme de tableau JSON. Également disponible à /schemas/{schema_name}. Les références d’image sont résolues en URL, et lorsque language est défini la traduction correspondante est fusionnée avec le contenu de base.

Auth : Clé API. Une clé n’est requise que lorsque le serveur définit require_schema_api_key = true; sinon, les lectures anonymes sont autorisées.

Paramètres de chemin

ParamètreTypeObligatoireNotes
schema_namestringouiLe schéma de document, par exemple post.

Paramètres de requête

ParamètreTypeObligatoireNotes
websiteIduuidnonSite web cible; se replie sur l’en-tête / la configuration Host.
iduuidnonRécupère un seul document. Prioritaire sur ids.
idsstringnonUUID séparés par des virgules (lot, 200 max). Prioritaire sur la pagination.
languagestringnonFusionne la traduction pour cette locale avec le contenu de base.
limitintegernonTaille de page, par défaut 200, plafonnée à 200.
offsetintegernonNombre de lignes à ignorer (appliqué uniquement avec une limite positive).
api_keystringnonAlternative à l’en-tête x-api-key.

Lorsque ni id ni ids ne sont définis, les documents sont renvoyés triés par published_at DESC.

Réponse

Un tableau JSON diffusé en continu. Chaque élément correspond au contenu publié du document aplati au niveau supérieur, plus les clés _id, _title et _publishedAt injectées :

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

Les champs de contenu prévalent sur les clés injectées en cas de collision. Les références d’image de la forme { alt, _asset: { id } } reçoivent une url résolue injectée dans _asset.

Exemple

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

Erreurs

  • 400 — websiteId invalide, id invalide ou ids incorrect (vide, plus de 200 ou UUID invalide)
  • 401 — clé API invalide (ou manquante lorsqu’elle est requise)
  • 500 — échec de la requête
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›