GET /dataset/{schema_name}

Recupere documentos publicados para um esquema — todos, um, um lote ou uma página — como uma matriz JSON transmitida.

Recupere documentos publicados para um esquema — todos, um único documento, um lote por IDs ou uma página — transmitidos como uma matriz JSON. Também disponível em /schemas/{schema_name}. Referências de imagem são resolvidas em URLs e, quando language é definido, a tradução correspondente é mesclada sobre o conteúdo base.

Auth: chave de API. Uma chave só é necessária quando o servidor define require_schema_api_key = true; caso contrário, leituras anônimas são permitidas.

Parâmetros de rota

Parâmetro	Tipo	Obrigatório	Observações
`schema_name`	string	sim	O esquema do documento, por exemplo `post`.

Parâmetros de consulta

Parâmetro	Tipo	Obrigatório	Observações
`websiteId`	uuid	não	Site de destino; usa o cabeçalho `Host`/configuração como padrão.
`id`	uuid	não	Busca um único documento. Tem precedência sobre `ids`.
`ids`	string	não	UUIDs separados por vírgulas (lote, máximo de 200). Tem precedência sobre a paginação.
`language`	string	não	Mescla a tradução para esse locale sobre o conteúdo base.
`limit`	integer	não	Tamanho da página, padrão `200`, limitado a `200`.
`offset`	integer	não	Linhas a serem ignoradas (aplicado apenas com um limite positivo).
`api_key`	string	não	Alternativa ao cabeçalho `x-api-key`.

Quando nem id nem ids são definidos, os documentos são retornados ordenados por published_at DESC.

Resposta

Uma matriz JSON transmitida. Cada elemento é o conteúdo publicado do documento espalhado no nível superior, além das chaves injetadas _id, _title e _publishedAt:

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

Campos de conteúdo prevalecem sobre as chaves injetadas em caso de colisão. Referências de imagem no formato { alt, _asset: { id } } recebem uma url resolvida injetada em _asset.

Exemplo

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

Erros

400 — websiteId inválido, id inválido ou ids incorreto (vazio, mais de 200 ou um UUID inválido)
401 — chave de API inválida (ou ausente quando obrigatória)
500 — falha na consulta

Previous‹GET /components/{name}NextGET /content-changes (SSE)›