profound-logoProfound CMS
⌘K
Admin
Theme
DocsGuidaBlogPhilosophy
DocsGuidaBlogPhilosophy

Hybrid

Instradamento parametricoTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Senza testa

Guida rapidaSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetOttieni percorsogetGET /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}

Recupera i documenti pubblicati per uno schema — tutti, uno, un batch o una pagina — come array JSON in streaming.

Recupera i documenti pubblicati per uno schema — tutti, un singolo documento, un batch per ID o una pagina — trasmessi come array JSON. Disponibile anche su /schemas/{schema_name}. I riferimenti alle immagini vengono risolti in URL e, quando language è impostato, la traduzione corrispondente viene unita al contenuto di base.

Autenticazione: Chiave API. Una chiave è necessaria solo quando il server imposta require_schema_api_key = true; altrimenti sono consentite letture anonime.

Parametri di percorso

ParametroTipoObbligatorioNote
schema_namestringsìLo schema del documento, ad es. post.

Parametri di query

ParametroTipoObbligatorioNote
websiteIduuidnoSito di destinazione; in caso contrario ricorre all'intestazione/configurazione Host.
iduuidnoRecupera un singolo documento. Ha la precedenza su ids.
idsstringnoUUID separati da virgole (batch, max 200). Ha la precedenza sulla paginazione.
languagestringnoUnisce la traduzione per questa lingua al contenuto di base.
limitintegernoDimensione della pagina, predefinita 200, limitata a 200.
offsetintegernoRighe da saltare (applicato solo con un limite positivo).
api_keystringnoAlternativa all'intestazione x-api-key.

Quando né id né ids sono impostati, i documenti vengono restituiti ordinati per published_at DESC.

Risposta

Un array JSON in streaming. Ogni elemento è il contenuto pubblicato del documento disteso al livello superiore, più le chiavi _id, _title e _publishedAt inserite:

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

I campi del contenuto hanno la precedenza sulle chiavi inserite in caso di conflitto. I riferimenti immagine della forma { alt, _asset: { id } } ricevono un url risolto inserito in _asset.

Esempio

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

Errori

  • 400 — websiteId non valido, id non valido o ids errati (vuoti, più di 200 o un UUID non valido)
  • 401 — chiave API non valida (o assente quando richiesta)
  • 500 — errore nella query
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›