Skip to main content
GET
/
rewards
Listar Rewards
curl --request GET \
  --url https://api.example.com/rewards
{
  "rewards": [
    {
      "uid": "rwd_001",
      "product": {
        "uid": "prd_001",
        "name": "Pizza Margherita Grande",
        "description": "Pizza tradicional com molho de tomate, mussarela e manjericão",
        "image_url": "https://storage.indiqai.com/products/pizza.jpg",
        "category": "Pizzas"
      },
      "empresa": {
        "id": "emp_123",
        "name": "Pizzaria Exemplo",
        "logo_url": "https://..."
      },
      "pontos_necessarios": 200,
      "cashback_value": null,
      "stock_available": 15,
      "expires_at": "2024-12-31T23:59:59Z",
      "can_redeem": true,
      "user_points": 350
    },
    {
      "uid": "rwd_002",
      "product": {
        "uid": "prd_002",
        "name": "Refrigerante 2L",
        "description": "Refrigerante de cola gelado",
        "image_url": "https://storage.indiqai.com/products/refri.jpg",
        "category": "Bebidas"
      },
      "empresa": {
        "id": "emp_123",
        "name": "Pizzaria Exemplo",
        "logo_url": "https://..."
      },
      "pontos_necessarios": 50,
      "cashback_value": null,
      "stock_available": 100,
      "expires_at": null,
      "can_redeem": true,
      "user_points": 350
    }
  ],
  "user_summary": {
    "total_points": 350,
    "empresa_id": "emp_123"
  }
}

Listar Rewards

Retorna os prêmios disponíveis para resgate pelo usuário.

Query Parameters

empresa_id
string
Filtrar por empresa específica
category
string
Filtrar por categoria
min_points
integer
Pontos mínimos necessários
max_points
integer
Pontos máximos necessários
available_only
boolean
default:true
Mostrar apenas rewards com estoque

Request

curl -X GET "https://api.indiqai.com/api/v1/rewards?empresa_id=emp_123" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Response

{
  "rewards": [
    {
      "uid": "rwd_001",
      "product": {
        "uid": "prd_001",
        "name": "Pizza Margherita Grande",
        "description": "Pizza tradicional com molho de tomate, mussarela e manjericão",
        "image_url": "https://storage.indiqai.com/products/pizza.jpg",
        "category": "Pizzas"
      },
      "empresa": {
        "id": "emp_123",
        "name": "Pizzaria Exemplo",
        "logo_url": "https://..."
      },
      "pontos_necessarios": 200,
      "cashback_value": null,
      "stock_available": 15,
      "expires_at": "2024-12-31T23:59:59Z",
      "can_redeem": true,
      "user_points": 350
    },
    {
      "uid": "rwd_002",
      "product": {
        "uid": "prd_002",
        "name": "Refrigerante 2L",
        "description": "Refrigerante de cola gelado",
        "image_url": "https://storage.indiqai.com/products/refri.jpg",
        "category": "Bebidas"
      },
      "empresa": {
        "id": "emp_123",
        "name": "Pizzaria Exemplo",
        "logo_url": "https://..."
      },
      "pontos_necessarios": 50,
      "cashback_value": null,
      "stock_available": 100,
      "expires_at": null,
      "can_redeem": true,
      "user_points": 350
    }
  ],
  "user_summary": {
    "total_points": 350,
    "empresa_id": "emp_123"
  }
}

Campos da Resposta

rewards
array
Lista de rewards disponíveis
user_summary
object
Resumo dos pontos do usuário na empresa

Próximo: Resgatar Reward

Resgatar Reward

Endpoint para trocar pontos por um prêmio