> For the complete documentation index, see [llms.txt](https://apidoc.toplojas.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidoc.toplojas.com.br/newsletter/listar-newsletter.md).

# Listar Newsletter

Retorna a **listagem dos inscritos** na newsletter da loja, com suporte a filtros e paginação.

```
GET /newsletter/
```

## 🔎 Filtros disponíveis

Os filtros são enviados na **Query** da requisição. Todos são opcionais e podem ser combinados.

| Parâmetro      | Tipo    | Descrição                                                         |
| -------------- | ------- | ----------------------------------------------------------------- |
| `Status`       | texto   | Filtra pelo status do inscrito: `A` (Ativado) ou `D` (Desativado) |
| `ChaveBusca`   | texto   | Pesquisa pelo **Nome** ou **E-mail** do inscrito                  |
| `Pagina`       | inteiro | Página desejada (paginação)                                       |
| `QtdPorPagina` | inteiro | Registros por página (máx. **100**)                               |

## 📥 Exemplo de requisição

Buscando inscritos **ativos**, pesquisando por "teste", 50 por página:

```bash
curl -X GET "https://api.toplojas.com.br/newsletter/?Status=A&ChaveBusca=teste&QtdPorPagina=50" \
  -H "Authorization: Bearer [Token]" \
  -H "Loja: [Identificador de Sua Loja]"
```

## 📤 Exemplo de resposta

A resposta segue o padrão de paginação (`Dados` + `Paginacao`):

```json
{
  "Dados": [
    {
      "Codigo": 142639,
      "Status": "A",
      "Nome": "teste1",
      "Email": "teste1@google.com.br"
    }
  ],
  "Paginacao": {
    "PaginaAtual": 1,
    "QtdPaginas": 1,
    "QtdRegistros": 1
  }
}
```

## 📋 Campos retornados

| Campo    | Tipo    | Descrição                                             |
| -------- | ------- | ----------------------------------------------------- |
| `Codigo` | inteiro | Código do inscrito na newsletter                      |
| `Status` | texto   | Status do inscrito: `A` (Ativado) ou `D` (Desativado) |
| `Nome`   | texto   | Nome do inscrito                                      |
| `Email`  | texto   | E-mail do inscrito                                    |

{% hint style="info" %}
Consulte a descrição de cada campo na referência:

{% embed url="<https://api.toplojas.com.br/doc/#/Newsletter>" %}
{% endhint %}

Para entender o funcionamento da paginação, veja:

{% content-ref url="/pages/-MObwaEfNJbBvr8ZSK0U" %}
[Paginação](/funcionamento/paginacao.md)
{% endcontent-ref %}