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

# Listar Usuários Banidos

> Retorna a lista de todos os usuários banidos. Requer autenticação JWT.

## Descrição

Retorna a lista de todos os usuários banidos do programa de indicações. **Requer autenticação JWT**.

## Headers

<ParamField header="Authorization" type="string" required>
  Token JWT no formato: Bearer {token}
</ParamField>

## Query Parameters

<ParamField query="page" type="number" default="1">
  Número da página
</ParamField>

<ParamField query="limit" type="number" default="20">
  Número de itens por página (máximo: 100)
</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="banned_users" type="array">
      <Expandable title="banned user object">
        <ResponseField name="email" type="string">
          Email do usuário banido
        </ResponseField>

        <ResponseField name="banned_at" type="string">
          Data e hora do banimento
        </ResponseField>

        <ResponseField name="reason" type="string">
          Motivo do banimento
        </ResponseField>

        <ResponseField name="banned_by" type="string">
          Email do administrador que aplicou o banimento
        </ResponseField>

        <ResponseField name="referrals_before_ban" type="number">
          Número de indicações antes do banimento
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="pagination" type="object">
      <Expandable title="properties">
        <ResponseField name="total" type="number">
          Total de usuários banidos
        </ResponseField>

        <ResponseField name="page" type="number">
          Página atual
        </ResponseField>

        <ResponseField name="limit" type="number">
          Itens por página
        </ResponseField>

        <ResponseField name="pages" type="number">
          Total de páginas
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash theme={null}
  curl --request GET \
    --url 'https://backend.testeswaffle.org/referrals/banned?page=1&limit=50' \
    --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "success": true,
    "data": {
      "banned_users": [
        {
          "email": "usuario.banido@exemplo.com",
          "banned_at": "2024-01-15T16:45:00Z",
          "reason": "Múltiplas tentativas de fraude detectadas",
          "banned_by": "admin@thenewscc.com.br",
          "referrals_before_ban": 47
        }
      ],
      "pagination": {
        "total": 12,
        "page": 1,
        "limit": 50,
        "pages": 1
      }
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /referrals/banned
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/banned:
    get:
      tags:
        - Authenticated
      summary: Listar Usuários Banidos
      description: Retorna a lista de todos os usuários banidos. Requer autenticação JWT.
      parameters:
        - name: page
          in: query
          schema:
            type: number
            default: 1
          description: Número da página
        - name: limit
          in: query
          schema:
            type: number
            default: 20
            maximum: 100
          description: Itens por página
      responses:
        '200':
          description: Lista de usuários banidos
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      banned_users:
                        type: array
                        items:
                          type: object
                      pagination:
                        type: object
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````