1. Buscando um cliente
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
      • 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
    • 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
    • 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. Buscando um cliente

Buscando tags vinculadas a um cliente

Developing
Sandbox
https://api.sandbox.neofin.services
Sandbox
https://api.sandbox.neofin.services
GET
https://api.sandbox.neofin.services
/customer/tags/{customer_identifier}

GET /tags/{customer_id}#

Retorna a listagem de tags associadas a um cliente específico.

Autenticação#

HeaderTipoObrigatórioDescrição
api-keystringSimChave de API da Company
secret-keystringSimChave secreta da Company

Parâmetros de Rota#

ParâmetroTipoObrigatórioDescrição
customer_idstring (UUID, document, integration_identifier)SimIdentificador interno do cliente na Neofin

Respostas#

200 OK — Cliente encontrado#

Retorna um objeto com o array customer_tags. Cada item contém o ID interno e o nome da tag.
Se o cliente existir mas não possuir tags associadas, customer_tags será um array vazio.
{
  "customer_tags": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "tag_name": "VIP"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "tag_name": "Inadimplente"
    }
  ]
}
Cliente sem tags:
{
  "customer_tags": []
}

404 Not Found — Cliente não encontrado#

Retornado quando nenhum cliente com o customer_id informado é encontrado dentro da Company autenticada.
{
  "message": "Customer with ID: <customer_id> not found"
}
Isolamento de tenant: A consulta é limitada à Company vinculada às credenciais enviadas no header. Um customer_id válido pertencente a outra Company também retornará 404.

500 Internal Server Error#

Retornado quando ocorre um erro inesperado no servidor.
{
  "message": "Problems get customer tags"
}

Exemplo de Requisição#

Request

Path Params

Responses

🟢200Success
application/json
Bodyapplication/json

🟠403Invalid API Keys
🔴500Internal Server Error
🟠404Customer Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.sandbox.neofin.services/customer/tags/'
Response Response Example
200 - Example 1
{
    "customer_tags": [
        {
            "id": "string",
            "tag_name": "string"
        }
    ]
}
Previous
Listando réguas disponíveis
Next
Como preparar seus webhooks
Built with