> 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/clientes/visao-geral.md).

# Visão Geral

Através da API de **Clientes** você pode **consultar** os clientes cadastrados na sua loja: listar (com busca e paginação) e ver os detalhes de um cliente específico.

{% hint style="info" %}
O módulo de Clientes é **somente leitura (consulta)**. O cadastro dos clientes é feito pela própria loja, no checkout/site — a API apenas oferece a **consulta** desses dados. Não existem endpoints para criar, editar ou excluir clientes.
{% endhint %}

{% hint style="info" %}
Estas páginas são **guias práticos**. A referência completa de cada campo, tipo e schema está no simulador online:

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

## 🧭 Endpoints de Clientes

| Ação                     | Método | Rota                  |
| ------------------------ | ------ | --------------------- |
| Listar e buscar clientes | GET    | `/clientes/`          |
| Detalhes de um cliente   | GET    | `/clientes/{Codigo}/` |

## 🔔 Acompanhando novos clientes

Em vez de consultar a listagem repetidamente, você pode ser **notificado** quando um cliente é cadastrado ou editado, usando o recurso de Webhook (eventos `Clientes_Cadastro` e `Clientes_Edicao`):

{% content-ref url="/pages/rbiZGRer0EGAGyswrCCw" %}
[Webhook](/funcionamento/webhook.md)
{% endcontent-ref %}