GET

api

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>'

import requests

url = "https://api.indiqai.com/api/v1/public/loyalty-cards"

headers = {"X-API-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://api.indiqai.com/api/v1/public/loyalty-cards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.indiqai.com/api/v1/public/loyalty-cards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.indiqai.com/api/v1/public/loyalty-cards"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.indiqai.com/api/v1/public/loyalty-cards")
  .header("X-API-Key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.indiqai.com/api/v1/public/loyalty-cards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

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

{
  "detail": "API Key inválida ou revogada"
}

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

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"

const params = new URLSearchParams({
  client_id: '550e8400-e29b-41d4-a716-446655440000'
});

const response = await fetch(
  `https://api.indiqai.com/api/v1/public/loyalty-cards?${params}`,
  {
    headers: { 'X-API-Key': 'indiqai_sua_chave_aqui' }
  }
);

const data = await response.json();

import httpx

response = httpx.get(
    'https://api.indiqai.com/api/v1/public/loyalty-cards',
    params={'client_id': '550e8400-e29b-41d4-a716-446655440000'},
    headers={'X-API-Key': 'indiqai_sua_chave_aqui'}
)

data = response.json()

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"
  }
]

{
  "detail": "API Key inválida ou revogada"
}

Campos da Resposta

string

ID do progresso (user_loyalty_progress.id) usado também na rota de carimbo

string

ID do cliente dono do cartão

integer

Quantidade atual de carimbos no progresso

integer

Total de carimbos necessários para completar

boolean

Se o cartão foi completado

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

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

Carimbar CartãoAdicionar um carimbo a um cartão fidelidade

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>'

import requests

url = "https://api.indiqai.com/api/v1/public/loyalty-cards"

headers = {"X-API-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://api.indiqai.com/api/v1/public/loyalty-cards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.indiqai.com/api/v1/public/loyalty-cards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.indiqai.com/api/v1/public/loyalty-cards"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.indiqai.com/api/v1/public/loyalty-cards")
  .header("X-API-Key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.indiqai.com/api/v1/public/loyalty-cards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

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

{
  "detail": "API Key inválida ou revogada"
}

Comece aqui

Clientes

Cupons

Produtos

Cartões Fidelidade

Indicações

Quests Públicas

NFC-e

Email

Pontos

Métricas

Prêmios

Listar Cartões Fidelidade

Listar Cartões Fidelidade

Comportamento atual

Query Parameters

Request

Response

Campos da Resposta

Headers

Query Parameters

Response

​Listar Cartões Fidelidade

​Comportamento atual

​Query Parameters

​Request

​Response

​Campos da Resposta

Headers

Query Parameters

Response

Listar Cartões Fidelidade

Comportamento atual

Query Parameters

Request

Response

Campos da Resposta