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

Headless

SnelstartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetHaal gegenereerde blokken opgetGET /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}

Haalt gepubliceerde documenten voor een schema op — allemaal, één, een batch of een pagina — als een gestreamde JSON-array.

Haalt gepubliceerde documenten voor een schema op — allemaal, een enkel document, een batch op ID's of een pagina — gestreamd als een JSON-array. Ook beschikbaar op /schemas/{schema_name}. Afbeeldingsverwijzingen worden omgezet naar URL's, en wanneer language is ingesteld wordt de bijpassende vertaling over de basisinhoud heen samengevoegd.

Auth: API-sleutel. Een sleutel is alleen vereist wanneer de server require_schema_api_key = true instelt; anders zijn anonieme leesacties toegestaan.

Padparameters

ParameterTypeVereistOpmerkingen
schema_namestringjaHet documentschema, bijv. post.

Queryparameters

ParameterTypeVereistOpmerkingen
websiteIduuidneeDoelwebsite; valt terug op de Host-header/configuratie.
iduuidneeHaalt één document op. Gaat vóór ids.
idsstringneeDoor komma's gescheiden UUID's (batch, max. 200). Gaat vóór paginering.
languagestringneeVoegt de vertaling voor deze locale samen met de basisinhoud.
limitintegerneePaginagrootte, standaard 200, begrensd op 200.
offsetintegerneeRijen om over te slaan (alleen toegepast bij een positieve limiet).
api_keystringneeAlternatief voor de x-api-key-header.

Wanneer noch id noch ids is ingesteld, worden documenten geretourneerd in de volgorde published_at DESC.

Antwoord

Een gestreamde JSON-array. Elk element bevat de gepubliceerde inhoud van het document op het hoogste niveau, plus geïnjecteerde sleutels _id, _title en _publishedAt:

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

Inhoudsvelden hebben voorrang op de geïnjecteerde sleutels bij een conflict. Afbeeldingsverwijzingen met de vorm { alt, _asset: { id } } krijgen een opgeloste url geïnjecteerd in _asset.

Voorbeeld

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

Fouten

  • 400 — ongeldige websiteId, ongeldige id, of ongeldige ids (leeg, meer dan 200, of een ongeldige UUID)
  • 401 — ongeldige API-sleutel (of ontbreekt wanneer vereist)
  • 500 — queryfout
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›