👥 Gestão de Clientes (Backoffice)
Endpoints para visualização e exportação de dados de clientes cadastrados na plataforma.
Listar Clientes
Retorna uma lista paginada de clientes com suporte a filtros.
Endpoint: GET /backoffice/clients
Filtros Disponíveis
| Parâmetro | Tipo | Descrição |
|---|---|---|
search | string | Busca por Nome, Documento ou Telefone (numérico). |
status | string | Filtro por status do cliente. |
account_id | int | Filtra clientes vinculados a uma conta específica. |
created_from | date | Data inicial de criação (YYYY-MM-DD). |
created_to | date | Data final de criação (YYYY-MM-DD). |
per_page | int | Itens por página (Padrão: 15). |
Resposta (Exemplo)
json
{
"data": [
{
"id": 1,
"name": "Cliente Exemplo",
"document": "12345678901",
"email": "cliente@email.com",
"phone": "11999999999",
"status": "ACTIVE",
"account": {
"id": 10,
"name": "Conta Master"
},
"created_at": "2024-04-17 15:00:00"
}
]
}Detalhar Cliente
Retorna dados detalhados, incluindo endereços e chaves Pix associadas.
Endpoint: GET /backoffice/clients/\{id\}
Relatório de Clientes
Retorna a lista completa de clientes sem paginação.
Endpoint: GET /backoffice/reports/clients