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

Sem interface

Guia rápidoSplit Screen JSON Component Builder with LLMComponent Zod Pull

Api rest

Visão geral da API RESTgetConnect 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 /blocks

Buscar blocos por ID, na ordem da solicitação, com referências de imagem resolvidas.

Buscar blocos por ID para um site, com referências de imagem resolvidas para URLs. Os blocos são retornados na mesma ordem dos ids solicitados; IDs desconhecidos são ignorados silenciosamente.

Autenticação: Chave de API (cabeçalho x-api-key ou parâmetro de consulta api_key).

Parâmetros de consulta

ParâmetroTipoObrigatórioObservações
websiteIduuidnãoSite de destino; reverte para o cabeçalho Host/configuração.
idsstringnãoUUIDs de blocos separados por vírgula. Vazio ou ausente → [].
api_keystringnãoAlternativa ao cabeçalho x-api-key.

Resposta

Uma matriz JSON de blocos:

[
  {
    "id": "...",
    "website_id": "...",
    "schema_id": "...",
    "draft_content": {},
    "published_content": {},
    "state": "published",
    "version": 3,
    "schema_name": "hero-block",
    "layout": {},
    "cloned_from_id": null,
    "created_at": "2026-06-23T18:34:16Z",
    "updated_at": "2026-06-23T20:36:55Z"
  }
]

Exemplo

curl '{CMS_API_URL}/blocks?websiteId=<uuid>&ids=<id1>,<id2>' \
  -H 'x-api-key: <key>'

Erros

  • 400 — UUID inválido em ids, ou site não resolvido
  • 401 — Chave de API inválida
Continue Reading
Previous‹GET /routeNextGET /blocks/with-cel-cache›