**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Sends a test email for the specified campaign

Send Test Email

Sends a test email for the specified campaign

bearerAuth

Phishy

Introduction

Statistics and Reports

Development

Overview

Learn how to effectively manage and utilize target audience data for tailored phishing simulations.

Targets and Groups

Training Posters

Template Feedback

Training Settings

Configuration

Reported Mail

Active Users

Frequently Asked Questions

Overview and integration guidelines for Phishy API

Learn how to authenticate with the Phishy API

Authentication

Understanding authorization mechanisms in Phishy API

Authorization

API Reference

Campaign

Create Campaign

All Campaigns

SMTP

SMTP Profile list

Mail Template

Template List

Template Creation

Template Tools

Attachments

Landing Page

Page List

Page Creation

Synchronization

LDAP Settings

Details about the Phishy Simulation Module

Overview of Email Phishing simulations in the Phishy Simulation Module

Email Phishing

Overview of Vishing simulations in the Phishy Simulation Module

Vishing

Overview of Smishing simulations in the Phishy Simulation Module

Smishing

Returns profiles from the system that the user has access to

Get Profiles

Get All Profiles

Returns a single profile based on the ID supplied

Get Profile By Id

Create Profile

Sends a test email to verify email functionality

Update Profile

Deletes a profile based on the ID supplied

Delete Profile By Id

Retrieves targets based on query parameters

Get Targets

Get All Targets

Create Target

Update Targets

Delete Target

Calculate Imported Targets

Imports targets from a provided data source

Import Targets

Deletes multiple targets based on provided identifiers

Bulk Delete

Delete All Bulk Targets

Retrieves groups based on query parameters

Get Groups

Get All Groups

Retrieves basic information of all groups

Get All Groups Basic

Create Groups

Update Group

Delete Group

Deletes multiple groups based on provided identifiers

Bulk Delete Groups

Delete All Bulk Group

Retrieves pages based on query parameters

Get Pages

Get All Pages

Get Page

Create New Page

Update Pages

Clones an existing page based on the provided ID

Clone Page

Delete Pages

Retrieves templates based on query parameters

Get Templates

Get All Templates

Retrieves the HTML content of a specific template by ID

Creates a new template with provided details

Create Template

Update Templates

Clones an existing template based on the provided ID

Clone Template

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Retrieves a list of all attachments

Get attachments

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Downloads a specific attachment by ID

Get Attachment

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Creates a new attachment

Create Attachment

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Deletes a specific attachment by ID

DELETE Attachments

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Retrieves a list of all campaigns

Get Campaigns

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Creates a new campaign

Create Campaigns

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Retrieves detailed information of a specific campaign

Get Campaigns Details

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Get Campaigns Timeline Event

Get Campaigns Timeline Events

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Get Campaigns Event Target

Get Campaigns Event Targets

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Schedules a campaign to start at a specified time

Schedule Campaign

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Launches a specified campaign

Launch Campaign

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Pauses a specified campaign

Pause Campaign

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Resumes a paused campaign

Resume Campaign

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Completes a specified campaign

Complete Campaign

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Get Campaigns Targets

Get Campaign Targets

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Calculates targets for a specified campaign

calculate Campaign Targets

Generate Campaign Excel Report

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Sync Campaign With Cloud

Sync Campaign With Cloud

**Note: This endpoint is subject to change and may not be supported in future releases.** 

 Deletes a specified campaign

API Documentation

Endpoints

Send Test Email

Authorizations

Path Parameters

Response