Skip to main content
GET
/
api
/
v1
/
public
/
clients
/
{client_id}
Buscar cliente
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/clients/{client_id} \
  --header 'X-API-Key: <x-api-key>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "nome": "João Silva",
  "email": "joao@email.com",
  "telefone": "+5511999999999",
  "cpf": "***456789**",
  "pontos": 1250,
  "total_compras": 15,
  "total_indicacoes": 3,
  "cartoes_fidelidade": 2,
  "created_at": "2025-06-15T10:30:00Z",
  "last_activity_at": "2026-03-10T14:22:00Z"
}

​
Detalhes do Cliente

Retorna informações detalhadas de um cliente específico da sua empresa.

​
Path Parameters

​
client_id
string
required
ID único do cliente (UUID)

​
Request

curl -X GET "https://api.indiqai.com/api/v1/public/clients/550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-Key: indiqai_sua_chave_aqui"

​
Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "nome": "João Silva",
  "email": "joao@email.com",
  "telefone": "+5511999999999",
  "cpf": "***456789**",
  "pontos": 1250,
  "total_compras": 15,
  "total_indicacoes": 3,
  "cartoes_fidelidade": 2,
  "created_at": "2025-06-15T10:30:00Z",
  "last_activity_at": "2026-03-10T14:22:00Z"
}

​
Campos da Resposta

​
id
string
ID único do cliente (UUID)
​
nome
string
Nome do cliente
​
email
string
Email do cliente (pode ser null)
​
telefone
string
Telefone do cliente (pode ser null)
​
cpf
string
CPF parcialmente mascarado
​
pontos
integer
Saldo atual de pontos
​
total_compras
integer
Número total de compras registradas
​
total_indicacoes
integer
Número de indicações feitas pelo cliente
​
cartoes_fidelidade
integer
Quantidade de cartões fidelidade ativos
​
created_at
string
Data de cadastro (ISO 8601)
​
last_activity_at
string
Data da última atividade (ISO 8601, pode ser null)

Headers

​
X-API-Key
string
required

Chave de API da empresa

Path Parameters

​
client_id
string
required

Response

Successful Response

Dados de um cliente.

​
id
string
required
​
nome
string
required
​
created_at
string<date-time> | null
​
email
string | null
​
pontos
integer
default:0
​
telefone
string | null