Gerenciar os funcionários (colaboradores alvo de suas simulações) a partir dos seus próprios sistemas: folha de pagamento, HRIS, scripts de sincronização, etc.
Criar, atualizar, consultar e excluir funcionários sem passar pela interface do Whalemate.
Consultar o histórico de eventos de campanha de um colaborador (aberturas, cliques, denúncias, credenciais comprometidas, etc.).
Base URL:
Todos os endpoints estão sob o prefixo {{base_url}}/api/companies/v1.
Para obter o host de produção (
base_url), entre em contato com seu representante Whalemate ou escreva para nós através do chat de suporte.
Autenticação:
A API usa autenticação por API Key através do header X-API-KEY.
X-API-KEY: tu_api_key_de_empresa
Você pode gerar ou consultar sua chave em Configuração → Integrações → cartão Chaves API → Chaves Ativas. Os detalhes estão 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 no body nem na URL, e cada requisição opera apenas sobre as vítimas da sua empresa.
Headers obrigatórios:
Header | Valor | Obrigatório |
|---|---|---|
| Sua API Key de empresa | ✅ Sim |
|
| ✅ Sim (em |
|
| ✅ Sim |
GET {{base_url}}/api/companies/v1/victims
Param | Tipo | Padrão | Descrição |
|---|---|---|---|
| integer |
| Quantidade de resultados por página |
| string | — | Filtra por nome (correspondência parcial) |
| string | — | Filtra por sobrenome (parcial) |
| string | — | Filtra por email (parcial) |
| string | — | Filtra por departamento (parcial) |
