Skip to main content
GET
/
api
/
v1
/
public
/
loyalty-cards
/
programs
Listar programas de cartão de fidelidade
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/loyalty-cards/programs \
  --header 'X-API-Key: <x-api-key>'
[
  {
    "name": "<string>",
    "program_id": "<string>",
    "cards_issued": 0,
    "created_at": "2023-11-07T05:31:56Z",
    "max_stamps": 0,
    "reward_description": "<string>",
    "status": "active"
  }
]

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.

​
Programas de Fidelidade

Lista os programas de cartão de fidelidade da empresa com metadados e contadores básicos.

​
Filtro opcional

  • status: active ou inactive

​
Status comuns

  • 200 programas retornados
  • 401 API Key inválida ou revogada
  • 403 plano sem api_access
  • 422 query inválida

Headers

​
X-API-Key
string
required

Chave de API

Query Parameters

​
status
string | null

Filtrar por status: "active" ou "inactive"

Response

Successful Response

​
name
string
required
​
program_id
string
required
​
cards_issued
integer
default:0
​
created_at
string<date-time> | null
​
max_stamps
integer
default:0
​
reward_description
string | null
​
status
string
default:active