> ## 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 programas de cartão de fidelidade da empresa

# 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


## OpenAPI

````yaml GET /api/v1/public/loyalty-cards/programs
openapi: 3.1.0
info:
  contact:
    email: support@indiqai.com
    name: IndiqAI Support
    url: https://indiqai.com/
  description: Especificação OpenAPI da API Pública IndiqAI.
  license:
    name: Proprietary
    url: https://indiqai.com/license
  title: IndiqAI API Pública
  version: 1.5.0
servers:
  - description: Produção
    url: https://api.indiqai.com
security: []
paths:
  /api/v1/public/loyalty-cards/programs:
    get:
      tags:
        - API Pública
      summary: Listar programas de cartão de fidelidade
      description: >-
        Lista programas de cartão de fidelidade da empresa com contagem de
        cartões emitidos.
      operationId: list_loyalty_card_programs_api_v1_public_loyalty_cards_programs_get
      parameters:
        - description: 'Filtrar por status: "active" ou "inactive"'
          in: query
          name: status
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: 'Filtrar por status: "active" ou "inactive"'
            title: Status
        - description: Chave de API
          in: header
          name: X-API-Key
          required: true
          schema:
            description: Chave de API
            title: X-Api-Key
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LoyaltyCardProgramResponse'
                title: >-
                  Response List Loyalty Card Programs Api V1 Public Loyalty
                  Cards Programs Get
                type: array
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    LoyaltyCardProgramResponse:
      description: Dados de um programa de cartão de fidelidade.
      properties:
        cards_issued:
          default: 0
          title: Cards Issued
          type: integer
        created_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Created At
        max_stamps:
          default: 0
          title: Max Stamps
          type: integer
        name:
          title: Name
          type: string
        program_id:
          title: Program Id
          type: string
        reward_description:
          anyOf:
            - type: string
            - type: 'null'
          title: Reward Description
        status:
          default: active
          title: Status
          type: string
      required:
        - program_id
        - name
      title: LoyaltyCardProgramResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object

````