Skip to main content
GET
/
api
/
v1
/
public
/
points
/
{client_id}
Consultar saldo de pontos
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/points/{client_id} \
  --header 'X-API-Key: <x-api-key>'
{
  "client_id": "550e8400-e29b-41d4-a716-446655440000",
  "client_nome": "João Silva",
  "balance": 1250,
  "total_earned": 2500,
  "total_spent": 1250,
  "last_transaction_at": "2026-03-18T11:45:00Z"
}

Saldo de Pontos

Retorna o saldo atual de pontos e histórico resumido de um cliente.

Path Parameters

client_id
string
required
ID do cliente (UUID)

Request

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

Response

{
  "client_id": "550e8400-e29b-41d4-a716-446655440000",
  "client_nome": "João Silva",
  "balance": 1250,
  "total_earned": 2500,
  "total_spent": 1250,
  "last_transaction_at": "2026-03-18T11:45:00Z"
}

Campos da Resposta

client_id
string
ID do cliente
client_nome
string
Nome do cliente
balance
integer
Saldo atual de pontos disponíveis
total_earned
integer
Total de pontos já recebidos (histórico completo)
total_spent
integer
Total de pontos já utilizados
last_transaction_at
string
Data da última transação de pontos (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

Saldo de pontos de um cliente.

balance
integer
required
client_id
string
required
empresa_id
string
required