profound-logoProfound CMS
⌘K
Admin
Theme
DokumenteTutorialBlogPhilosophie
DokumenteTutorialBlogPhilosophie

Hybrid

Parametrisches RoutingKomponenten-TypenSetup server sent events (SSE) content refetchEinrichtung-Admin-Panel-ProxyScripting im Template-BuilderProject ScaffoldingMedienbibliothek

Headless

SchnellstartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST-API

REST API OverviewgetWebsite mit der CMS-API verbindengetRouten abrufengetRoute abrufengetBlöcke abrufengetBlöcke mit CEL-Cache abrufengetGET /blocks/generatedgetKomponenten abrufengetKomponentenname abrufengetGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postNachbearbeitung der ÜbersetzungpatchPatch-ÜbersetzungengetNutzung abrufenpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /dataset/{schema_name}

Veröffentlichte Dokumente für ein Schema abrufen — alle, eines, eine Gruppe oder eine Seite — als gestreamtes JSON-Array.

Rufe veröffentlichte Dokumente für ein Schema ab — alle, ein einzelnes Dokument, eine Gruppe nach IDs oder eine Seite — als gestreamtes JSON-Array. Ebenfalls verfügbar unter /schemas/{schema_name}. Bildreferenzen werden zu URLs aufgelöst, und wenn language gesetzt ist, wird die passende Übersetzung mit dem Basisinhalt zusammengeführt.

Auth: API-Schlüssel. Ein Schlüssel wird nur benötigt, wenn der Server require_schema_api_key = true setzt; andernfalls sind anonyme Lesezugriffe erlaubt.

Pfadparameter

ParameterTypErforderlichHinweise
schema_namestringjaDas Dokumentschema, z. B. post.

Abfrageparameter

ParameterTypErforderlichHinweise
websiteIduuidneinZielwebsite; fällt auf den Host-Header bzw. die Konfiguration zurück.
iduuidneinRuft ein einzelnes Dokument ab. Hat Vorrang vor ids.
idsstringneinKommagetrennte UUIDs (Stapel, max. 200). Hat Vorrang vor der Paginierung.
languagestringneinÜberlagert den Basisinhalt mit der Übersetzung für dieses Gebietsschema.
limitintegerneinSeitengröße, Standard 200, begrenzt auf 200.
offsetintegerneinZu überspringende Zeilen (wird nur bei positivem Limit angewendet).
api_keystringneinAlternative zum Header x-api-key.

Wenn weder id noch ids gesetzt ist, werden die Dokumente in der Reihenfolge published_at DESC zurückgegeben.

Antwort

Ein gestreamtes JSON-Array. Jedes Element enthält den veröffentlichten Inhalt des Dokuments auf oberster Ebene sowie die eingefügten Schlüssel _id, _title und _publishedAt:

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

Felder aus dem Inhalt haben bei Kollision Vorrang vor den eingefügten Schlüsseln. Bildreferenzen der Form { alt, _asset: { id } } erhalten eine aufgelöste url, die in _asset eingefügt wird.

Beispiel

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

Fehler

  • 400 — ungültige websiteId, ungültige id oder fehlerhafte ids (leer, mehr als 200 oder eine ungültige UUID)
  • 401 — ungültiger API-Schlüssel (oder fehlt, obwohl erforderlich)
  • 500 — Abfragefehler
Continue Reading
Previous‹Komponentenname abrufenNextGET /content-changes (SSE)›