Skip to main content
GET
/
api
/
v1
/
public
/
loyalty-cards
Listar cartões de fidelidade
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/loyalty-cards \
  --header 'X-API-Key: <x-api-key>'
{
  "loyalty_cards": [
    {
      "id": "card_001",
      "client_id": "550e8400-e29b-41d4-a716-446655440000",
      "client_nome": "João Silva",
      "total_stamps": 10,
      "current_stamps": 7,
      "completed": false,
      "reward_name": "Pizza Grátis",
      "created_at": "2025-12-01T10:00:00Z",
      "last_stamp_at": "2026-03-15T16:30:00Z"
    }
  ],
  "total": 1
}

​
Listar Cartões Fidelidade

Retorna os cartões fidelidade da empresa. Pode ser filtrado por cliente específico.

​
Query Parameters

​
client_id
string
Filtrar cartões de um cliente específico (UUID)

​
Request

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

​
Response

{
  "loyalty_cards": [
    {
      "id": "card_001",
      "client_id": "550e8400-e29b-41d4-a716-446655440000",
      "client_nome": "João Silva",
      "total_stamps": 10,
      "current_stamps": 7,
      "completed": false,
      "reward_name": "Pizza Grátis",
      "created_at": "2025-12-01T10:00:00Z",
      "last_stamp_at": "2026-03-15T16:30:00Z"
    }
  ],
  "total": 1
}

​
Campos da Resposta

​
loyalty_cards
array
Lista de cartões fidelidade
​
loyalty_cards[].id
string
ID único do cartão
​
loyalty_cards[].client_id
string
ID do cliente dono do cartão
​
loyalty_cards[].client_nome
string
Nome do cliente
​
loyalty_cards[].total_stamps
integer
Total de carimbos necessários para completar
​
loyalty_cards[].current_stamps
integer
Carimbos atuais
​
loyalty_cards[].completed
boolean
Se o cartão foi completado
​
loyalty_cards[].reward_name
string
Nome da recompensa ao completar
​
loyalty_cards[].created_at
string
Data de criação (ISO 8601)
​
loyalty_cards[].last_stamp_at
string
Data do último carimbo (ISO 8601, pode ser null)
​
total
integer
Total de cartões retornados

Headers

​
X-API-Key
string
required

Chave de API da empresa

Query Parameters

​
client_id
string | null

Response

Successful Response

​
id
string
required
​
client_id
string | null
​
completed
boolean
default:false
​
created_at
string<date-time> | null
​
max_stamps
integer
default:0
​
stamps
integer
default:0