VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Páginas de conteúdo

GETListar páginas

Devolve as páginas de conteúdo da loja com filtros por status, tipo, texto e dono.

Devolve as páginas institucionais da loja (Sobre nós, Política de troca, Privacidade...), com filtros e paginação. Páginas apagadas não aparecem. Páginas escondidas e rascunhos aparecem, com o status correspondente.

GET/api/v1/admin/pagesAdmin

Lista as páginas de conteúdo da loja

Exige o privilégio manage_content ou view_content.

Parâmetros de consulta

pageintegerpadrão: 1
Número da página, a partir de 1.
per_pageintegerpadrão: 20
Itens por página, de 1 a 100. Fora desse intervalo vale 20.
statusstring
activehiddendraftdisabled
Filtra pelo status.
page_typestring
pagebloglink
Filtra pelo tipo.
searchstring
Texto contido no título ou no slug, sem diferenciar maiúsculas.
vendor_iduuid
Só páginas desse seller. Tem prioridade sobre marketplace_only.
marketplace_onlyboolean
Com true, 1 ou yes, só páginas da loja (sem seller). Sem filtro de dono, a lista mistura as duas origens.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/pages?status=active&per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Página de resultados
json
{
  "pages": [
    {
      "id": "cc37f047-702b-45c7-9f88-3e8d42e81011",
      "title": "Política de Troca",
      "slug": "politica-de-troca",
      "body": "<p>Você pode trocar em até 7 dias.</p>",
      "status": "active",
      "page_type": "page",
      "position": 0,
      "id_path": "",
      "created_at": "2026-10-11T21:04:48.445487Z",
      "updated_at": "2026-10-11T21:04:48.445487Z",
      "page_id": "cc37f047-702b-45c7-9f88-3e8d42e81011",
      "page": "politica-de-troca",
      "page_title": "Política de Troca",
      "description": "<p>Você pode trocar em até 7 dias.</p>",
      "seo_name": "politica-de-troca",
      "timestamp": 1791752688,
      "updated_timestamp": 1791752688
    }
  ],
  "total": 32,
  "page": 1,
  "per_page": 20,
  "total_pages": 2
}

Campos da resposta

pagesarray

Páginas desta consulta. Não conte com uma ordenação por data.

iduuid
Identificador da página.
titlestring
Título, em texto puro (HTML é removido).
slugstring
Trecho da URL pública (/politica-de-troca). Único na loja.
bodystring
Conteúdo em HTML, já sanitizado: <script>, atributos on... e links javascript: são removidos.
statusstring
active, hidden ou draft. Veja o aviso sobre disabled.
page_typestring
page, blog ou link.
seo_titlestring
Título para buscadores. Ausente quando vazio.
seo_descriptionstring
Descrição para buscadores. Ausente quando vazia.
positioninteger
Ordem de exibição em menus. Menor aparece primeiro.
parent_iduuid
Página pai, quando a página faz parte de uma hierarquia. Ausente na raiz.
vendor_iduuid
Seller dono da página. Ausente quando a página é da loja inteira (marketplace).
created_atstring
Criação, RFC 3339 em UTC.
updated_atstring
Última alteração, RFC 3339 em UTC.
totalinteger
Total de páginas que atendem ao filtro.
pageinteger
Página devolvida.
per_pageinteger
Itens por página efetivamente usados.
total_pagesinteger
Total de páginas de resultado.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"invalid or expired token"}
403O administrador não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["manage_content","view_content"]}
500Falha ao consultar o banco.{"error":"failed to list pages","detail":"..."}
Campos repetidos

A resposta também traz campos que repetem outros valores (page_id, page, page_title, description, seo_name, timestamp, updated_timestamp). Eles repetem valores que já estão nos campos acima; em integrações novas use os campos principais.

Veja também

  • Consultar página
  • Criar página
Anterior
Páginas de conteúdo
Próxima
Consultar página
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também