profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsKomponenttyperSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyScripting i skabelonbyggerenProject ScaffoldingMediebibliotek

Headless

HurtigstartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

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

Hent publicerede dokumenter for et skema — alle, ét, en batch eller en side — som en streamet JSON-array.

Hent publicerede dokumenter for et skema — alle, et enkelt dokument, en batch efter ID'er eller en side — streamet som en JSON-array. Findes også på /schemas/{schema_name}. Billedreferencer bliver opløst til URL'er, og når language er sat, flettes den matchende oversættelse ind over basisindholdet.

Auth: API-nøgle. En nøgle er kun påkrævet, når serveren sætter require_schema_api_key = true; ellers er anonyme læsninger tilladt.

Sti-parametre

ParameterTypePåkrævetBemærkninger
schema_namestrengjaDokumentskemaet, f.eks. post.

Forespørgselsparametre

ParameterTypePåkrævetBemærkninger
websiteIduuidnejMålwebsted; falder tilbage til Host-header / konfiguration.
iduuidnejHent et enkelt dokument. Trumfer ids.
idsstrengnejKommaseparerede UUID'er (batch, maks. 200). Trumfer paginering.
languagestrengnejFlet oversættelsen for denne locale ind over basisindholdet.
limitheltalnejSidestørrelse, standard 200, begrænset til 200.
offsetheltalnejRækker der skal springes over (anvendes kun med en positiv grænse).
api_keystrengnejAlternativ til x-api-key-headeren.

Når hverken id eller ids er sat, returneres dokumenter sorteret efter published_at DESC.

Svar

En streamet JSON-array. Hvert element er dokumentets publicerede indhold spredt på øverste niveau samt indsprøjtede nøgler _id, _title og _publishedAt:

[
  {
    "_id": "...",
    "_title": "Kom godt i gang",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Kom godt i gang",
    "description": "...",
    "content": "..."
  }
]

Indholdsfelter vinder over de indsprøjtede nøgler ved kollision. Billedreferencer med formen { alt, _asset: { id } } får en opløst url indsat i _asset.

Eksempel

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

Fejl

  • 400 — ugyldig websiteId, ugyldig id eller forkerte ids (tom, mere end 200 eller en ugyldig UUID)
  • 401 — ugyldig API-nøgle (eller mangler, når det kræves)
  • 500 — forespørgselsfejl
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›