Marketing

Listar Newsletter

E-mails inscritos para receber novidades

GET

/v1/newsletter

Escopo

marketing.ler

Para enviar campanhas, use só os confirmados (pediram e confirmaram pelo e-mail, como pede a LGPD).

Autorização

Authorizationstringobrigatórioheader

Chave da API no formato Bearer hdl_live_.... Crie no painel da loja em Integração › API e webhooks. Saiba mais.

Parâmetros de consulta

paginaintegerquery

Página (padrão 1).

por_paginaintegerquery

Itens por página, de 1 a 100 (padrão 20).

situacaostringquery

confirmado, aguardando_confirmacao ou descadastrado.

emailstringquery

Resposta

200 — objeto { "dados": ... } (veja o exemplo).

Erros possíveis

HTTP	código	quando
`400`	`json_invalido`	O corpo não é um JSON válido (confira também a codificação UTF-8).
`400`	`parametro_invalido`	Um parâmetro de consulta tem formato errado (ex.: data).
`401`	`nao_autenticado`	Faltou o cabeçalho Authorization: Bearer <chave>.
`401`	`chave_invalida`	Chave inexistente ou revogada.
`403`	`sem_permissao`	A chave não tem o escopo exigido pelo endpoint.

import os, requests resposta = requests.get( "https://api.hoteldaslojas.com.br/v1/newsletter", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/newsletter'); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('HDL_CHAVE')], ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "dados": [ { "id": 14, "email": "[email protected]", "origem": "api", "situacao": "aguardando_confirmacao", "inscrito_em": "2026-10-28T03:01:00-03:00", "confirmado_em": null, "descadastrado_em": null } ], "paginacao": { "pagina": 1, "por_pagina": 20, "total": 1, "paginas": 1 } }

{ "erro": { "codigo": "sem_permissao", "mensagem": "Esta chave não tem o escopo \"pedidos.ler\". Crie uma chave com esse escopo no painel da loja (Integração › API).", "request_id": "req_95f4a872c180063c" } }