Hotel das LojasHotel das LojasAPI
Buscar na documentação...Ctrl K

Clientes

Listar Clientes

Lista os clientes cadastrados

GET
/v1/clientes

Escopo

clientes.ler

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).

buscastringquery

Nome, e-mail ou WhatsApp.

emailstringquery

E-mail exato.

criado_desdestringquery

Cadastrados a partir desta data.

Resposta

200 — objeto { "dados": [...], "paginacao": {...} } com uma lista de Cliente e a paginação.

Erros possíveis

HTTPcódigoquando
401nao_autenticadoFaltou o cabeçalho Authorization: Bearer <chave>.
401chave_invalidaChave inexistente ou revogada.
403sem_permissaoA chave não tem o escopo exigido pelo endpoint.

© Hotel das Lojas · API v1.0 · hoteldaslojas.com.br

GET/clientes

Este endpoint precisa de uma chave da sua loja com o escopo clientes.ler. Ele altera dados de verdade.