Lista clientes

GET /api/{userId}/establishment/{establishmentId}/clients

Parâmetros de rota

Nome	Tipo	Descrição
userId	number	Identificador do usuário
establishmentId	number	Identificador do estabelecimento

Parâmetros de consulta (query string)

Todos opcionais.

Nome	Tipo	Descrição
page	number	Número da página
sort	string	Ordenação: asc ou desc (padrão: asc)
orderBy	string	Coluna em jump_clients para ordenar (padrão: name)
clientType	number	Filtra por clientTypeId (valores permitidos): 1 (avulso), 2 (mensalista), 4 (pós-pago), 5 (pós-pago estética)
status	number	Filtra por status do vínculo no estabelecimento (padrão se omitido: 1)
clientInvoiceSituation	number	Situação da fatura (valores permitidos): 1 (em dia), 2 (vencida), 3 (outra situação), 4 (fechada no mês). Observação: para ver mensalistas pagos no mês, use clientInvoiceSituation=4.
plate	string	Filtra por placa de veículo (JSON de veículos do cliente)
search	string	Busca em nome, e-mail ou documento
card	string	Filtra clientes que possuam o cartão informado em cards
export	any	Se presente, inclui campos extras (vehicles, vacancies) e dados de exportação

Requisição

• Método: GET
• Path: /api/\{userId\}/establishment/\{establishmentId\}/clients
• Headers: Authorization, Accept: application/json
• Autorização: envie o token no header Authorization: Bearer <YOUR_API_TOKEN>.

Formato da resposta (JSON)

Todas as respostas seguem o envelope da API (app/Utils/ApiResponse.php):

• Sucesso (HTTP 200): { "response": "success", "data": <payload> }
• Erro (HTTP 400): { "response": "error", "data": { "msg": "...", "code": "..." } }
• Não autorizado / permissão: veja Autorização (401, 403).

O payload de sucesso abaixo é o valor de data.

Exemplo de resposta (JSON)

{
  "response": "success",
  "data": {
    "total": 7,
    "content": [
      {
        "establishmentId": 4193,
        "clientId": "938420260110112847",
        "name": "Camila Rocha",
        "email": "[email protected]",
        "phones": ["+5521993344556", "+5521980011223"],
        "clientTypeId": 1,
        "hasInvoice": 1,
        "invoiceDateTime": "20260110194738",
        "clientInvoiceSituationId": 1,
        "dueDateTime": "2026-01-20 23:59:59",
        "invoiceAmount": 442.0
      }
    ]
  }
}