# Phishy ## Docs - [Authentication](https://docs.phishy.io/api-reference/authentication.md): Learn how to authenticate with the Phishy API - [Authorization](https://docs.phishy.io/api-reference/authorization.md): Understanding authorization mechanisms in Phishy API - [Email Phishing](https://docs.phishy.io/api-reference/email-phishing.md): Overview of Email Phishing simulations in the Phishy Simulation Module - [Create Attachment](https://docs.phishy.io/api-reference/endpoint/attachments/createAttachment.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [DELETE Attachments](https://docs.phishy.io/api-reference/endpoint/attachments/deleteAttachment.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Get Attachment](https://docs.phishy.io/api-reference/endpoint/attachments/getAttachment.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Get attachments](https://docs.phishy.io/api-reference/endpoint/attachments/getAttachments.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Create Campaigns](https://docs.phishy.io/api-reference/endpoint/campaigns/createCampaign.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Complete Campaign](https://docs.phishy.io/api-reference/endpoint/campaigns/createCompleteCampaign.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Launch Campaign](https://docs.phishy.io/api-reference/endpoint/campaigns/createLaunchCampaign.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Pause Campaign](https://docs.phishy.io/api-reference/endpoint/campaigns/createPauseCampaign.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Resume Campaign](https://docs.phishy.io/api-reference/endpoint/campaigns/createResumeCampaign.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Schedule Campaign](https://docs.phishy.io/api-reference/endpoint/campaigns/createScheduleCampaign.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Send Test Email](https://docs.phishy.io/api-reference/endpoint/campaigns/createSendTestEmail.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [DELETE Campaigns](https://docs.phishy.io/api-reference/endpoint/campaigns/deleteCampaign.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [calculate Campaign Targets](https://docs.phishy.io/api-reference/endpoint/campaigns/getCalculateCampaignTargets.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Get Campaign Targets](https://docs.phishy.io/api-reference/endpoint/campaigns/getCampaignTargets.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Get Campaigns](https://docs.phishy.io/api-reference/endpoint/campaigns/getCampaigns.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Get Campaigns Details](https://docs.phishy.io/api-reference/endpoint/campaigns/getCampaignsDetails.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Get Campaigns Event Targets](https://docs.phishy.io/api-reference/endpoint/campaigns/getCampaignsEventTargets.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Get Campaigns Timeline Events](https://docs.phishy.io/api-reference/endpoint/campaigns/getCampaignsTimelineEvents.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Generate Campaign Excel Report](https://docs.phishy.io/api-reference/endpoint/campaigns/getGenerateCampaignExcelReport.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Sync Campaign With Cloud](https://docs.phishy.io/api-reference/endpoint/campaigns/getSyncCampaignWithCloud.md): **Note: This endpoint is subject to change and may not be supported in future releases.** - [Bulk Delete Groups](https://docs.phishy.io/api-reference/endpoint/groups/createBulkDeleteGroups.md): Deletes multiple groups based on provided identifiers - [Create Groups](https://docs.phishy.io/api-reference/endpoint/groups/createGroups.md): Creates a new group - [Delete All Bulk Group](https://docs.phishy.io/api-reference/endpoint/groups/deleteAllBulkGroups.md): Deletes all groups in bulk - [Delete Group](https://docs.phishy.io/api-reference/endpoint/groups/deleteGroup.md): Deletes a specific group by ID - [Get All Groups](https://docs.phishy.io/api-reference/endpoint/groups/getAllGroups.md): Retrieves all groups - [Get All Groups Basic](https://docs.phishy.io/api-reference/endpoint/groups/getAllGroupsBasic.md): Retrieves basic information of all groups - [Get Groups](https://docs.phishy.io/api-reference/endpoint/groups/getGroups.md): Retrieves groups based on query parameters - [Update Group](https://docs.phishy.io/api-reference/endpoint/groups/updateGroup.md): Updates a specific group by ID - [Clone Page](https://docs.phishy.io/api-reference/endpoint/pages/createClonePage.md): Clones an existing page based on the provided ID - [Create New Page](https://docs.phishy.io/api-reference/endpoint/pages/createNewPage.md): Creates a new page with provided details - [Delete Pages](https://docs.phishy.io/api-reference/endpoint/pages/deletePage.md): Deletes a specific page by ID - [Get All Pages](https://docs.phishy.io/api-reference/endpoint/pages/getAllPages.md): Retrieves all pages - [Get Page](https://docs.phishy.io/api-reference/endpoint/pages/getPage.md): Retrieves a specific page by ID - [Get Pages](https://docs.phishy.io/api-reference/endpoint/pages/getPages.md): Retrieves pages based on query parameters - [Update Pages](https://docs.phishy.io/api-reference/endpoint/pages/updatePage.md): Updates a specific page by ID - [Create Profile](https://docs.phishy.io/api-reference/endpoint/profiles/createProfile.md): Creates a new profile - [Send Test Email](https://docs.phishy.io/api-reference/endpoint/profiles/createTestEmail.md): Sends a test email to verify email functionality - [Delete Profile By Id](https://docs.phishy.io/api-reference/endpoint/profiles/deleteProfile.md): Deletes a profile based on the ID supplied - [Get All Profiles](https://docs.phishy.io/api-reference/endpoint/profiles/getAllProfiles.md): Returns all profiles without pagination - [Get Profile By Id](https://docs.phishy.io/api-reference/endpoint/profiles/getProfile.md): Returns a single profile based on the ID supplied - [Get Profiles](https://docs.phishy.io/api-reference/endpoint/profiles/getProfiles.md): Returns profiles from the system that the user has access to - [Update Profile](https://docs.phishy.io/api-reference/endpoint/profiles/updateProfile.md): Updates an existing profile - [Bulk Delete](https://docs.phishy.io/api-reference/endpoint/targets/createBulkDeleteTargets.md): Deletes multiple targets based on provided identifiers - [Calculate Imported Targets](https://docs.phishy.io/api-reference/endpoint/targets/createCalculateImportedTargets.md): Calculates metrics for imported targets - [Import Targets](https://docs.phishy.io/api-reference/endpoint/targets/createImportTargets.md): Imports targets from a provided data source - [Create Target](https://docs.phishy.io/api-reference/endpoint/targets/createTarget.md): Creates a new target - [Delete All Bulk Targets](https://docs.phishy.io/api-reference/endpoint/targets/deleteAllBulkTargets.md): Deletes all targets in bulk - [Delete Target](https://docs.phishy.io/api-reference/endpoint/targets/deleteTarget.md): Deletes a specific target by ID - [Get All Targets](https://docs.phishy.io/api-reference/endpoint/targets/getAllTargets.md): Retrieves all targets - [Get Targets](https://docs.phishy.io/api-reference/endpoint/targets/getTargets.md): Retrieves targets based on query parameters - [Update Targets](https://docs.phishy.io/api-reference/endpoint/targets/updateTarget.md): Updates a specific target by ID - [Clone Template](https://docs.phishy.io/api-reference/endpoint/templates/createCloneTemplate.md): Clones an existing template based on the provided ID - [Create Template](https://docs.phishy.io/api-reference/endpoint/templates/createTemplate.md): Creates a new template with provided details - [Update Templates](https://docs.phishy.io/api-reference/endpoint/templates/deleteTemplate.md): Deletes a specific template by ID - [Get All Templates](https://docs.phishy.io/api-reference/endpoint/templates/getAllTemplates.md): Retrieves all templates - [Get Templates](https://docs.phishy.io/api-reference/endpoint/templates/getHtmlFromTemplate.md): Retrieves the HTML content of a specific template by ID - [Get Templates](https://docs.phishy.io/api-reference/endpoint/templates/getTemplate.md): Retrieves a specific template by ID - [Get Templates](https://docs.phishy.io/api-reference/endpoint/templates/getTemplates.md): Retrieves templates based on query parameters - [Update Templates](https://docs.phishy.io/api-reference/endpoint/templates/updateTemplate.md): Updates a specific template by ID - [Introduction](https://docs.phishy.io/api-reference/introduction.md): Overview and integration guidelines for Phishy API - [Smishing](https://docs.phishy.io/api-reference/simishing.md): Overview of Smishing simulations in the Phishy Simulation Module - [Overview](https://docs.phishy.io/api-reference/simulations.md): Details about the Phishy Simulation Module - [Vishing](https://docs.phishy.io/api-reference/vishing.md): Overview of Vishing simulations in the Phishy Simulation Module - [Development](https://docs.phishy.io/development.md): Learn how to preview changes locally - [Active Users](https://docs.phishy.io/incident/activeUsers.md) - [Configuration](https://docs.phishy.io/incident/configuration.md) - [Overview](https://docs.phishy.io/incident/overview.md) - [Reported Mail](https://docs.phishy.io/incident/reportedMail.md) - [Introduction](https://docs.phishy.io/introduction.md) - [Campaign](https://docs.phishy.io/simulations/campaign/Campaign.md) - [All Campaigns](https://docs.phishy.io/simulations/campaign/allCampaigns.md) - [Create Campaign](https://docs.phishy.io/simulations/campaign/campaignCreation.md) - [Landing Page](https://docs.phishy.io/simulations/landing/landingPage.md) - [Page Creation](https://docs.phishy.io/simulations/landing/pageCreation.md) - [Page List](https://docs.phishy.io/simulations/landing/pageList.md) - [Attachments](https://docs.phishy.io/simulations/mailTemp/attachments.md) - [Mail Template](https://docs.phishy.io/simulations/mailTemp/mailTemplate.md) - [Template Creation](https://docs.phishy.io/simulations/mailTemp/templateCreation.md) - [Template List](https://docs.phishy.io/simulations/mailTemp/templateList.md) - [Template Tools](https://docs.phishy.io/simulations/mailTemp/templateTools.md) - [Overview](https://docs.phishy.io/simulations/simulation.md) - [SMTP](https://docs.phishy.io/simulations/smtp/smtpProfile.md) - [SMTP Profile list](https://docs.phishy.io/simulations/smtp/smtpProfileList.md) - [Targets and Groups](https://docs.phishy.io/simulations/targetAndGroups.md): Learn how to effectively manage and utilize target audience data for tailored phishing simulations. - [Statistics and Reports](https://docs.phishy.io/statisticsAndReports.md) - [Frequently Asked Questions](https://docs.phishy.io/system/faq.md) - [Overview](https://docs.phishy.io/system/ldap.md) - [LDAP Settings](https://docs.phishy.io/system/ldapSettings.md) - [Overview](https://docs.phishy.io/system/overview.md) - [Synchronization](https://docs.phishy.io/system/synchronization.md) - [Overview](https://docs.phishy.io/training/overview.md) - [Template Feedback](https://docs.phishy.io/training/trainingFeedback.md) - [Training Posters](https://docs.phishy.io/training/trainingPosters.md) - [Training Settings](https://docs.phishy.io/training/trainingSettings.md) ## OpenAPI Specs - [attachments](https://docs.phishy.io/api-reference/endpoint/attachments/attachments.json) - [campaigns](https://docs.phishy.io/api-reference/endpoint/campaigns/campaigns.json) - [target](https://docs.phishy.io/api-reference/endpoint/targets/target.json) - [openapi](https://docs.phishy.io/api-reference/endpoint/openapi.json)