Consultar suas campanhas de simulação (phishing, credential harvesting, ransomware) a partir dos seus próprios sistemas: reporting, dashboards internos, integrações com seu SIEM, etc.
Base URL: todos os endpoints vivem sob o prefixo {{base_url}}/api/companies/v1.
Para obter o host de produção (
base_url), entre em contato com seu representante da Whalemate ou escreva para nós através do chat de suporte.
Autenticação: header X-API-KEY.
X-API-KEY: tu_api_key_de_empresa
Gere ou consulte sua chave em Configuração → Integrações → cartão Chaves API → Chaves Ativas. Detalhes em Chaves API: como gerá-las, usá-las e revogá-las.
A empresa é resolvida automaticamente a partir da API Key: você não envia company_id, e cada request opera unicamente sobre as campanhas da sua empresa.
Header | Valor | Obrigatório |
|---|---|---|
| Sua API Key de empresa | ✅ Sim |
|
| ✅ Sim |
GET {{base_url}}/api/companies/v1/campaigns
Paginado: retorna no máximo per_page campanhas por request, envolvidas em data/links/meta.
Param | Tipo | Default | Descrição |
|---|---|---|---|
| data (YYYY-MM-DD) | 1 mês atrás |
|
| data (YYYY-MM-DD) | hoje |
|
| integer | 50 | Campanhas por página |
| integer | 1 | Número da página |
Sem filter[from]/filter[to] se aplica o intervalo padrão (último mês). Não há filtro por status.
Exemplo:
