Skip to main content
GET
Listar programas de cartão de fidelidade

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