Engage / API v1
Clientes

Buscar por ID

Retorna os dados completos de um cliente a partir do seu identificador único.

GET/v1/customers/id/:id

Use este endpoint para recuperar o cliente quando você já conhece o id — geralmente recebido na resposta de POST /v1/customers. A resposta inclui os dados principais e o objeto customFields.

Obrigatório

Apenas o parâmetro de path id é obrigatório. Não há body nem query string.

Exemplo

http
GET /v1/customers/id/c3a1b2d4-9f5e-4a8b-9c0d-1e2f3a4b5c6d

Parâmetros de path

  • idstring (uuid)obrigatório
    Identificador único do cliente, recebido no campo id da resposta de criação.

Campos da resposta

  • idstringopcional
    Identificador único do cliente.
  • uniqueKeystringopcional
    Identificador de negócio do cliente (CPF, código do ERP, ID interno etc.). Único por empresa.
  • namestringopcional
    Nome do cliente.
  • emailstring | nullopcional
    E-mail do cliente, se cadastrado.
  • phonestring | nullopcional
    Telefone, se cadastrado.
  • statusstringopcional
    active, inactive, vip ou churned.
  • preferredChannelstringopcional
    email, whatsapp, sms ou phone.
  • tagsstring[]opcional
    Lista de tags do cliente.
  • locationstring | nullopcional
    Cidade ou região, se preenchida.
  • companystring | nullopcional
    Empresa, se preenchida.
  • birthDatestring (ISO 8601) | nullopcional
    Data de nascimento, se preenchida.
  • createdAtstring (ISO 8601)opcional
    Quando o cliente foi cadastrado.
  • customFieldsobjectopcional
    Mapa { <nome do campo>: valor } com os campos customizados preenchidos. Vazio se nenhum campo foi definido.