1. Listando seus clientes
Neofin V1
latest
  • latest
  • english
  • Inicie sua jornada na Neofin
  • Preparando seus ambientes
  • Dúvidas frequentes
  • Premissas comportamentais da API (default x personalização)
  • Premissas de infraestrutura da API (default x personalização)
  • Versão 1
    • API de Cobranças
      • Upsert de Cobranças
        • Como realizar o upsert de uma cobrança
        • Upsert de Cobranças
          POST
      • Buscando uma cobrança
        • Como buscar uma única cobrança
        • Buscando pelo Integration Identifier
          GET
        • Buscando pelo Billing Number
          GET
      • Marcando uma cobrança como paga
        • Como marcar uma cobrança como paga
        • V2
          • Marcar como pago - V2
        • Marcando como paga
          PUT
      • Cancelando uma cobrança
        • Como cancelar uma cobrança
        • Cancelando uma cobrança
          PUT
      • Reabrindo uma cobrança
        • Como reabrir uma cobrança
        • Reabrir cobrança
      • Listando suas cobranças
        • Como listar suas cobranças
        • Todas as cobranças
          GET
        • Cobranças por status
          GET
        • Cobranças por cliente
          GET
        • Cobranças por data de atualização
          GET
        • Eventos de cobranças
          GET
        • Eventos de uma uma cobrança por Integration Identifier
          GET
        • Cobranças por data de pagamento
          GET
      • Listando suas parcelas
        • Parcelas por data de atualização
      • Enviando anexos
        • Como enviar anexos
        • Anexando outros arquivos
          POST
        • Anexando uma NF a uma cobrança pelo Integration Identifier
          PUT
        • Anexando um Boleto a uma cobrança pelo Integration Identifier
          PUT
      • Enviando Notificações
        • Reenvio de Notificações de Cobranças
        • Enviando notificações
      • Enviando Negativações
        • Envio de negativações
        • enviando negativações
      • Enviando Protestos
        • Envio de protestos
        • enviando protestos
      • Pausar cobrança
        • Pausar ou retomar notificações da cobrança
    • API de Clientes
      • Upsert de um cliente
        • Como realizar o upsert de um cliente
        • Upsert de clientes
          POST
      • Buscando um cliente
        • Buscando um cliente por Integration Identifier
          GET
        • Buscando um cliente pelo documento
          GET
        • Listando réguas disponíveis
          GET
        • Buscando tags vinculadas a um cliente
          GET
        • Listando usuários
          GET
      • Listando seus clientes
        • Como listar seus clientes
        • Todos os clientes
          GET
        • Clientes por situação
          GET
        • Clientes por data de criação
          GET
    • Webhooks
      • Como preparar seus webhooks
      • Como preparar seus webhooks - Atualizado
  • Schemas
    • API Return
      • BillingsOutput
      • BillingsEventsOutput
      • ResumedBillingsEventsOutput
      • BillingsByPaymentDateOutput
      • ForbidennModel
    • Enums
      • BillingStatusEnum
      • InstallmentTypeEnum
      • BillingType
    • Sub Entities
      • GenericBoleto
      • BillingInInstallment
      • Payments
    • Customer
      • Customer Tags
      • Customer
    • Billing
    • BillingEvent
    • ResumedBillingEvent
    • CommonReturnModel
    • BillingWithPayments
    • UpsertBilling
    • InstallmentWithBilling
    • Attachment
    • UpsertCustomer
  1. Listando seus clientes

Como listar seus clientes

Listar todos os clientes#

Lista os clientes cadastrados na sua conta, permitindo filtrar os resultados por situação e período de criação.
Cada página retorna até 50 resultados. Para acessar a próxima página, envie o next_page_token retornado na resposta anterior como parâmetro na próxima requisição.

Parâmetros opcionais:#

situation: Situação do cliente. Valores aceitos:
new: Novo
regular: Regular
default: Inadimplente
created_at_start: Timestamp inicial do período de criação.
created_at_end: Timestamp final do período de criação.

Retorno#

{
  "customers": [
    {
      "secondary_phone": "+55",
      "address_neighborhood": "teste",
      "name": "Joao Testao",
      "pause_notifications": false,
      "address_complement": "",
      "document": "19426070000134",
      "recipients": [],
      "mail": "invalido@gamil.com",
      "responsible_user_id": "b89e6606-7982-4486-b337-ac5f940e6abe",
      "address_street": "rua a",
      "phone": "+55",
      "trade_name": "Joao Testao Fantasia",
      "address_city": "Dois Vizinhos",
      "address_state": "PR",
      "responsible_user_name": "Andre Neves",
      "address_number": "1",
      "situation": "new",
      "address_zip_code": "85660000"
    },
    {
      "document": "50580635066",
      "secondary_phone": "+55",
      "name": "Lucas Tomkiel Portal",
      "address_number": "111",
      "pause_notifications": false,
      "address_complement": "",
      "recipients": [],
      "address_state": "SC",
      "responsible_user_id": "",
      "mail": "invalido@gamil.com",
      "address_street": "Rua Renato Scheunemann",
      "phone": "+55",
      "address_zip_code": "89237380",
      "responsible_user_name": "",
      "address_city": "Joinville",
      "situation": "new",
      "trade_name": "Lucas Tomkiel Portal Nome Fantasia",
      "address_neighborhood": "Vila Nova"
    },
  ],
  "next_page_token": null,
  "count": 2
}
Previous
Listando usuários
Next
Todos os clientes
Built with