For AI agents: visit https://api-docs.caniphish.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
CanIPhishCanIPhish
API Reference
Log InCanIPhish
API Reference
Log In
API Reference

CanIPhish API

  • Get started with the CanIPhish API

CanIPhish Public API

  • My Account
    • Get your entitlementspost
    • Get your user profilepost
    • Update your user profilepost
    • Get all my tenant IDspost
    • Get all my tenant IDs (detailed)post
  • Campaigns
    • Create Campaign
      • Create a phishing campaignpost
      • Create a training campaignpost
      • Create a phishing + training campaignpost
    • Update Campaign
      • Update a phishing campaignpost
      • Update a training campaignpost
      • Update a phishing + training campaignpost
    • List campaignspost
    • Get a campaign (full configuration)post
    • Delete a campaignpost
    • Duplicate a campaignpost
    • Send a test phishing emailpost
    • Campaign Targets
      • Bulk-resend a campaign emailpost
      • Mark a campaign target's email as reportedpost
      • Mark a campaign target's interaction as a false positivepost
      • Auto-complete an employee's trainingpost
      • Remove an employee from a phishing campaignpost
      • Remove an employee from a training campaignpost
      • Resend a training assignment to an employeepost
      • Resend a phishing campaign to an employeepost
  • Reporting
    • Campaign Results
      • Get per-employee phishing campaign resultspost
      • Get per-learner training campaign resultspost
      • Get a training completion certificatepost
      • Get all phishing campaignspost
      • Get all training campaignspost
    • Historic Campaigns
      • Rename an archived training campaignpost
      • Delete an archived training campaignpost
      • Rename an archived phishing campaignpost
      • Delete an archived phishing campaignpost
      • List archived (historic) campaignspost
    • Human Risk & Employees
      • Get human risk scorespost
      • Manually set an employee's Business Impact classificationpost
      • Update the security awareness leaderboard's badge date-range filterpost
      • Get the security awareness leaderboardpost
      • Erase an employee's data (GDPR)post
      • Get all dark-web datapost
      • Get individual dark-web datapost
      • Get all employee informationpost
    • Reports & Scheduling
      • Generate a report (PDF)post
      • List scheduled compliance reportspost
      • Update scheduled compliance reportspost
  • Employee Lists
    • Create Employee List
      • Create a manual employee listpost
      • Create a directory employee listpost
      • Create a dynamic employee listpost
    • Update Employee List
      • Update a manual employee listpost
      • Update a directory employee listpost
      • Update a dynamic employee listpost
    • Directory Integrations
      • List directory integrationspost
      • Add/update a directory integration (white-label)post
      • Get directory groupspost
    • Delete an employee listpost
    • Duplicate an employee listpost
    • List employee listspost
    • Get an employee list (with employees)post
  • Content Library
    • Phishing Emails
      • Create a phishing email templatepost
      • Update a phishing email templatepost
      • Delete a phishing email templatepost
      • Duplicate a phishing email templatepost
      • List phishing email templatespost
      • Get a phishing email template (with HTML body)post
    • Email Sender IDs
      • Create an email sender IDpost
      • Update an email sender IDpost
      • Delete an email sender IDpost
      • Duplicate an email sender IDpost
      • List email sender IDspost
    • Phishing Websites
      • Create a phishing website templatepost
      • Update a phishing website templatepost
      • Delete a phishing website templatepost
      • Duplicate a phishing website templatepost
      • List phishing website templatespost
      • Get a phishing website template (with custom HTML)post
    • Voice Phishing
      • Create a voice phishing templatepost
      • Update a voice phishing templatepost
      • Delete a voice phishing templatepost
      • Duplicate a voice phishing templatepost
      • List voice phishing templatespost
    • Training Modules
      • Create a training modulepost
      • Update a training modulepost
      • Delete a training modulepost
      • Duplicate a training modulepost
      • List training modulespost
      • Get a training module (full content)post
    • Reference Data
      • Get reference data (valid values)post
  • Domain Verification
    • Request domain verificationpost
    • Verify a domain with a codepost
    • List verified domainspost
    • Lock a verified domainpost
    • Delete a domainpost
    • Get domain supply-chain scanpost
  • Integrations
    • Get the outbound webhook configurationpost
    • Update the outbound webhookpost
    • Get webhook event typespost
  • Reported Emails
    • Reported Email Settings
      • Get reported-email settingspost
      • Update reported-email analysis settings (Enterprise)post
      • Update reported-email settings (general & notifications)post
      • Update reported-email quarantine settingspost
      • Save quarantine connector credentialspost
    • List reported (suspicious) emailspost
    • Attribute a reported emailpost
    • Attribute multiple reported emailspost
    • Get the report-phish Outlook add-in manifestpost
    • Get reported message detailspost
    • Clone a reported phish as a templatepost
  • Platform Settings
    • User Management
      • Add a platform userpost
      • Update a platform userpost
      • Delete a platform userpost
      • List platform userspost
    • Authentication & SSO
      • Get authentication settings (MFA + SSO state)post
      • Update platform MFA requirementpost
      • Update / activate / deactivate Platform SSOpost
      • Update / activate / deactivate Learner SSOpost
    • Email Delivery
      • Get email delivery settingspost
      • Create/update an email delivery provider (unified)post
      • Delete an email delivery providerpost
      • Set the default email delivery providerpost
    • Notifications
      • Get all notifications and dynamic identifierspost
      • Get a notification email's HTML (with language)post
      • Update a notification's textpost
      • Reset a notification to defaultpost
    • Phishing Settings
      • Get phishing settingspost
      • Update phishing education redirectpost
      • Update false-positive exclusionspost
      • Update the default phishing websitepost
    • Language
      • Get language settingspost
      • Update a language settingpost
    • Appearance
      • Get appearance settingspost
      • Update learner appearance settingspost
    • Training Settings
      • Get training settingspost
      • Update training settingspost
    • AI Knowledge Source
      • Get the AI knowledge source (Enterprise)post
      • Build (scan) the AI knowledge source (Enterprise)post
      • Publish (activate) the AI knowledge source (Enterprise)post
      • Update the AI knowledge source systems (Enterprise)post
      • Delete the AI knowledge source (Enterprise)post
    • Audit Log
      • View the SMTP delivery logspost
      • View the audit logpost
  • Onboarding
    • Get onboarding / setup status + recommendationspost
Powered by 

Platform Settings

Updated about 2 months ago


Clone a reported phish as a template
User Management

Updated about 2 months ago


Clone a reported phish as a template
User Management