Skip to main content
GET
/
api
/
v1
/
public
/
rewards
Listar recompensas
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/rewards \
  --header 'X-API-Key: <x-api-key>'
{
  "rewards": [
    {
      "uid": "rwd_001",
      "name": "Pizza Margherita Grátis",
      "description": "Uma pizza margherita média de cortesia",
      "points_cost": 500,
      "image_url": "https://storage.indiqai.com/rewards/pizza.jpg",
      "available": true,
      "stock": 10,
      "category": "Alimentação"
    },
    {
      "uid": "rwd_002",
      "name": "10% de Desconto",
      "description": "Desconto de 10% em qualquer pedido",
      "points_cost": 200,
      "image_url": null,
      "available": true,
      "stock": null,
      "category": "Desconto"
    }
  ],
  "total": 2
}

​
Listar Recompensas

Retorna as recompensas (prêmios) disponíveis para resgate pelos clientes da empresa.

​
Request

curl -X GET "https://api.indiqai.com/api/v1/public/rewards" \
  -H "X-API-Key: indiqai_sua_chave_aqui"

​
Response

{
  "rewards": [
    {
      "uid": "rwd_001",
      "name": "Pizza Margherita Grátis",
      "description": "Uma pizza margherita média de cortesia",
      "points_cost": 500,
      "image_url": "https://storage.indiqai.com/rewards/pizza.jpg",
      "available": true,
      "stock": 10,
      "category": "Alimentação"
    },
    {
      "uid": "rwd_002",
      "name": "10% de Desconto",
      "description": "Desconto de 10% em qualquer pedido",
      "points_cost": 200,
      "image_url": null,
      "available": true,
      "stock": null,
      "category": "Desconto"
    }
  ],
  "total": 2
}

​
Campos da Resposta

​
rewards
array
Lista de recompensas disponíveis
​
rewards[].uid
string
ID único da recompensa
​
rewards[].name
string
Nome da recompensa
​
rewards[].description
string
Descrição da recompensa (pode ser null)
​
rewards[].points_cost
integer
Custo em pontos para resgate
​
rewards[].image_url
string
URL da imagem (pode ser null)
​
rewards[].available
boolean
Se a recompensa está disponível para resgate
​
rewards[].stock
integer
Quantidade disponível em estoque (null = ilimitado)
​
rewards[].category
string
Categoria da recompensa (pode ser null)
​
total
integer
Total de recompensas

Headers

​
X-API-Key
string
required

Chave de API da empresa

Response

Successful Response

​
id
string
required
​
active
boolean
default:true
​
description
string | null
​
image_url
string | null
​
points_cost
integer | null
​
title
string | null