v1

latestOpenAPI 3.1.02026-07-2622098.6 KB

Listar Clientes

get/api/v1/clients

Path parameters

searchstring required
cpf_cnpjstring required
client_idinteger required
citystring required
statestring required
emailstring required
channelstring required
per_pageinteger required
pageinteger required

Response

200

drawinteger
recordsTotalinteger
recordsFilteredinteger

Example response

{
  "draw": 1,
  "recordsTotal": 100,
  "recordsFiltered": 50,
  "data": [
    {
      "id": 1,
      "name": "Cliente Exemplo",
      "email": "cliente@exemplo.com",
      "phone": "11999999999",
      "cpf_cnpj": "12345678900",
      "collect_address": "Rua Exemplo, 123",
      "channel": "Marketplace Exemplo",
      "active_accounts": 1
    }
  ]
}