> ## Documentation Index
> Fetch the complete documentation index at: https://docs.thenewscc.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Exportar Indicações

> Exporta dados de indicações em formato CSV

## Descrição

Exporta dados de indicações em formato CSV. Este endpoint permite exportação simplificada dos dados  **Requer autenticação JWT**.

## Query Parameters

<ParamField query="status" type="string">
  Filtrar por status (active, pending, all)
</ParamField>

<ParamField query="start_date" type="string">
  Data inicial no formato YYYY-MM-DD
</ParamField>

<ParamField query="end_date" type="string">
  Data final no formato YYYY-MM-DD
</ParamField>

## Response

Retorna um arquivo CSV com os dados das indicações.

### Campos do CSV

* `referrer_email`: Email do indicador
* `referred_email`: Email do indicado
* `status`: Status da indicação
* `created_at`: Data de criação
* `activated_at`: Data de ativação (se aplicável)

<RequestExample>
  ```bash theme={null}
  curl --request GET \
    --url 'https://backend.testeswaffle.org/referrals/export?status=active&start_date=2024-01-01' \
    --output referrals.csv
  ```
</RequestExample>

<ResponseExample>
  ```csv theme={null}
  referrer_email,referred_email,status,created_at,activated_at
  usuario1@exemplo.com,indicado1@exemplo.com,active,2024-01-15T10:00:00Z,2024-01-15T14:30:00Z
  usuario2@exemplo.com,indicado2@exemplo.com,active,2024-01-16T11:00:00Z,2024-01-16T15:45:00Z
  usuario3@exemplo.com,indicado3@exemplo.com,pending,2024-01-17T12:00:00Z,
  ```
</ResponseExample>


## OpenAPI

````yaml GET /referrals/export
openapi: 3.1.0
info:
  title: Referrals API
  description: API para gerenciamento do programa de indicações do the news
  version: 1.0.0
servers:
  - url: https://backend.testeswaffle.org
security:
  - bearerAuth: []
paths:
  /referrals/export:
    get:
      tags:
        - Public
      summary: Exportar Indicações
      description: Exporta dados de indicações em formato CSV
      parameters:
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - pending
              - all
          description: Filtrar por status
        - name: start_date
          in: query
          schema:
            type: string
            format: date
          description: Data inicial (YYYY-MM-DD)
        - name: end_date
          in: query
          schema:
            type: string
            format: date
          description: Data final (YYYY-MM-DD)
      responses:
        '200':
          description: Arquivo CSV com os dados
          content:
            text/csv:
              schema:
                type: string
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````