> ## 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.

# Contagem por Email

> Obtém a contagem de indicações para um email

## Descrição

Obtém a contagem de indicações ativas e pendentes para um email específico. Este endpoint é público e útil para mostrar o progresso do usuário.

## Path Parameters

<ParamField path="email" type="string" required>
  Email do usuário para consultar as indicações
</ParamField>

## Response

<ResponseField name="success" type="boolean">
  Indica se a operação foi bem-sucedida
</ResponseField>

<ResponseField name="data" type="object">
  <Expandable title="properties">
    <ResponseField name="active" type="number">
      Número de indicações ativas (confirmadas)
    </ResponseField>

    <ResponseField name="pending" type="number">
      Número de indicações pendentes de confirmação
    </ResponseField>

    <ResponseField name="total" type="number">
      Total de indicações (ativas + pendentes)
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash theme={null}
  curl --request GET \
    --url https://backend.testeswaffle.org/referrals/count/usuario@exemplo.com
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "success": true,
    "data": {
      "active": 12,
      "pending": 3,
      "total": 15
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /referrals/count/{email}
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/count/{email}:
    get:
      tags:
        - Public
      summary: Contagem por Email
      description: Obtém a contagem de indicações para um email
      parameters:
        - name: email
          in: path
          required: true
          schema:
            type: string
            format: email
          description: Email do usuário
      responses:
        '200':
          description: Contagem obtida com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      active:
                        type: number
                      pending:
                        type: number
                      total:
                        type: number
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````