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>'
[
  {
    "id": "progress_001",
    "client_id": "550e8400-e29b-41d4-a716-446655440000",
    "stamps": 7,
    "max_stamps": 10,
    "completed": false,
    "created_at": "2025-12-01T10:00:00Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.indiqai.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Listar Cartões Fidelidade

Retorna os progressos de fidelidade da empresa. Pode ser filtrado por cliente específico.

​
Comportamento atual

  • a resposta é uma lista simples, sem envelope total
  • cada item representa um user_loyalty_progress
  • o campo id retornado aqui é o identificador que deve ser usado em POST /loyalty-cards/{card_id}/stamp

​
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

[
  {
    "id": "progress_001",
    "client_id": "550e8400-e29b-41d4-a716-446655440000",
    "stamps": 7,
    "max_stamps": 10,
    "completed": false,
    "created_at": "2025-12-01T10:00:00Z"
  }
]

​
Campos da Resposta

​
[].id
string
ID do progresso (user_loyalty_progress.id) usado também na rota de carimbo
​
[].client_id
string
ID do cliente dono do cartão
​
[].stamps
integer
Quantidade atual de carimbos no progresso
​
[].max_stamps
integer
Total de carimbos necessários para completar
​
[].completed
boolean
Se o cartão foi completado
​
[].created_at
string
Data de criação (ISO 8601)

Headers

​
X-API-Key
string
required

Chave de API

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