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

# Listar Alertas

> Obter alertas para entidades ou organizações com filtragem e paginação — usando a API de alertas da gu1 para fluxos de risco e compliance.

## Visão Geral

Recupera alertas para entidades específicas ou em toda a organização. Os alertas são gerados automaticamente pelas regras quando as condições são atendidas.

## Endpoint

```
GET http://api.gu1.ai/intelligence/alerts
```

## Autenticação

Requer uma chave API válida no cabeçalho de Autorização:

```bash theme={null}
Authorization: Bearer YOUR_API_KEY
```

## Parâmetros de Consulta

<ParamField query="entityId" type="string" required>
  ID da entidade para filtrar alertas (pessoa, empresa ou transação)
</ParamField>

<ParamField query="status" type="string">
  Filtrar por status: `PENDING`, `ACKNOWLEDGED`, `RESOLVED`
</ParamField>

<ParamField query="severity" type="string">
  Filtrar por severidade: `LOW`, `MEDIUM`, `HIGH`, `CRITICAL`
</ParamField>

<ParamField query="category" type="string">
  Filtrar por categoria de alerta
</ParamField>

## Resposta

<ResponseField name="success" type="boolean">
  Se a requisição foi bem-sucedida
</ResponseField>

<ResponseField name="alerts" type="array">
  Array de objetos de alerta
</ResponseField>

<ResponseField name="count" type="number">
  Número total de alertas que correspondem aos filtros
</ResponseField>

## Exemplos de Requisições

### Obter Alertas para Entidade

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "http://api.gu1.ai/intelligence/alerts?entityId=550e8400-e29b-41d4-a716-446655440000" \
    -H "Authorization: Bearer YOUR_API_KEY"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'http://api.gu1.ai/intelligence/alerts?entityId=550e8400-e29b-41d4-a716-446655440000',
    {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
      }
    }
  );

  const data = await response.json();
  console.log(`Encontrados ${data.count} alertas`);
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'http://api.gu1.ai/intelligence/alerts',
      headers={
          'Authorization': 'Bearer YOUR_API_KEY'
      },
      params={
          'entityId': '550e8400-e29b-41d4-a716-446655440000'
      }
  )

  data = response.json()
  print(f"Encontrados {data['count']} alertas")
  ```
</CodeGroup>

## Exemplo de Resposta

```json theme={null}
{
  "success": true,
  "alerts": [
    {
      "id": "alert-uuid-123",
      "name": "Padrão de Transação de Alto Risco",
      "category": "transaction_monitoring",
      "severity": "CRITICAL",
      "status": "PENDING",
      "createdAt": "2024-12-23T10:00:00.000Z",
      "riskContribution": 25,
      "miniAnalysis": "Múltiplas transações de alto valor detectadas em curto período",
      "targetEntityId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "count": 1
}
```

## Níveis de Severidade de Alertas

* **LOW**: Informativo, requer revisão
* **MEDIUM**: Risco moderado, deve ser investigado
* **HIGH**: Risco significativo, requer atenção imediata
* **CRITICAL**: Risco severo, ação urgente necessária

## Fluxo de Status de Alertas

1. **PENDING**: Alerta recém-criado, aguardando revisão
2. **ACKNOWLEDGED**: O alerta foi revisado pela equipe de compliance
3. **RESOLVED**: O alerta foi tratado e fechado

## Veja Também

* [Reconhecer Alerta](/pt/api-reference/alerts/acknowledge)
* [Resolver Alerta](/pt/api-reference/alerts/resolve)
* [Obter Caixa de Entrada de Inteligência](/pt/api-reference/alerts/inbox)