For AI agents: the docs index is at https://api-docs.caniphish.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
API Reference
v1.0
v2.0
Unified read + management API
Log In
API Reference
Log In
Unified read + management API
API Reference
Reporting
CanIPhish API
Get started with the CanIPhish API
CanIPhish Public API
My Account
Get your entitlements
post
Get your user profile
post
Update your user profile
post
Get all my tenant IDs
post
Get all my tenant IDs (detailed)
post
Get your entitlements
post
Get your user profile
post
Update your user profile
post
Get all my tenant IDs
post
Get all my tenant IDs (detailed)
post
Campaigns
Create Campaign
Create a phishing campaign
post
Create a training campaign
post
Create a phishing + training campaign
post
Create a phishing campaign
post
Create a training campaign
post
Create a phishing + training campaign
post
Update Campaign
Update a phishing campaign
post
Update a training campaign
post
Update a phishing + training campaign
post
Update a phishing campaign
post
Update a training campaign
post
Update a phishing + training campaign
post
List campaigns
post
Get a campaign (full configuration)
post
Delete a campaign
post
Duplicate a campaign
post
Send a test phishing email
post
Campaign Targets
Bulk-resend a campaign email
post
Mark a campaign target's email as reported
post
Mark a campaign target's interaction as a false positive
post
Auto-complete an employee's training
post
Remove an employee from a phishing campaign
post
Remove an employee from a training campaign
post
Resend a training assignment to an employee
post
Resend a phishing campaign to an employee
post
Resend a phishing campaign to an employee
post
Remove an employee from a phishing campaign
post
Mark a campaign target's interaction as a false positive
post
Mark a campaign target's email as reported
post
Resend a training assignment to an employee
post
Remove an employee from a training campaign
post
Auto-complete an employee's training
post
Delete a campaign
post
Duplicate a campaign
post
List campaigns
post
Get a campaign (full configuration)
post
Send a test phishing email
post
Bulk-resend a campaign email
post
Reporting
Campaign Results
Get per-employee phishing campaign results
post
Get per-learner training campaign results
post
Get a training completion certificate
post
Get all phishing campaigns
post
Get all training campaigns
post
Get per-employee phishing campaign results
post
Get per-learner training campaign results
post
Get a training completion certificate
post
Get all phishing campaigns
post
Get all training campaigns
post
Historic Campaigns
Rename an archived training campaign
post
Delete an archived training campaign
post
Rename an archived phishing campaign
post
Delete an archived phishing campaign
post
List archived (historic) campaigns
post
List archived (historic) campaigns
post
Delete an archived phishing campaign
post
Rename an archived phishing campaign
post
Delete an archived training campaign
post
Rename an archived training campaign
post
Human Risk & Employees
Get human risk scores
post
Manually set an employee's Business Impact classification
post
Update the security awareness leaderboard's badge date-range filter
post
Get the security awareness leaderboard
post
Erase an employee's data (GDPR)
post
Get all dark-web data
post
Get individual dark-web data
post
Get all employee information
post
Get human risk scores
post
Manually set an employee's Business Impact classification
post
Update the security awareness leaderboard's badge date-range filter
post
Get the security awareness leaderboard
post
Erase an employee's data (GDPR)
post
Get all dark-web data
post
Get individual dark-web data
post
Get all employee information
post
Reports & Scheduling
Generate a report (PDF)
post
List scheduled compliance reports
post
Update scheduled compliance reports
post
Generate a report (PDF)
post
List scheduled compliance reports
post
Update scheduled compliance reports
post
Employee Lists
Create Employee List
Create a manual employee list
post
Create a directory employee list
post
Create a dynamic employee list
post
Create a manual employee list
post
Create a directory employee list
post
Create a dynamic employee list
post
Update Employee List
Update a manual employee list
post
Update a directory employee list
post
Update a dynamic employee list
post
Update a manual employee list
post
Update a directory employee list
post
Update a dynamic employee list
post
Directory Integrations
List directory integrations
post
Add/update a directory integration (white-label)
post
Get directory groups
post
List directory integrations
post
Add/update a directory integration (white-label)
post
Get directory groups
post
Delete an employee list
post
Duplicate an employee list
post
List employee lists
post
Get an employee list (with employees)
post
Delete an employee list
post
Duplicate an employee list
post
List employee lists
post
Get an employee list (with employees)
post
Content Library
Phishing Emails
Create a phishing email template
post
Update a phishing email template
post
Delete a phishing email template
post
Duplicate a phishing email template
post
List phishing email templates
post
Get a phishing email template (with HTML body)
post
Create a phishing email template
post
Update a phishing email template
post
Delete a phishing email template
post
Duplicate a phishing email template
post
List phishing email templates
post
Get a phishing email template (with HTML body)
post
Email Sender IDs
Create an email sender ID
post
Update an email sender ID
post
Delete an email sender ID
post
Duplicate an email sender ID
post
List email sender IDs
post
Create an email sender ID
post
Update an email sender ID
post
Delete an email sender ID
post
Duplicate an email sender ID
post
List email sender IDs
post
Phishing Websites
Create a phishing website template
post
Update a phishing website template
post
Delete a phishing website template
post
Duplicate a phishing website template
post
List phishing website templates
post
Get a phishing website template (with custom HTML)
post
Create a phishing website template
post
Update a phishing website template
post
Delete a phishing website template
post
Duplicate a phishing website template
post
List phishing website templates
post
Get a phishing website template (with custom HTML)
post
Voice Phishing
Create a voice phishing template
post
Update a voice phishing template
post
Delete a voice phishing template
post
Duplicate a voice phishing template
post
List voice phishing templates
post
Create a voice phishing template
post
Update a voice phishing template
post
Delete a voice phishing template
post
Duplicate a voice phishing template
post
List voice phishing templates
post
Training Modules
Create a training module
post
Update a training module
post
Delete a training module
post
Duplicate a training module
post
List training modules
post
Get a training module (full content)
post
Create a training module
post
Update a training module
post
Delete a training module
post
Duplicate a training module
post
List training modules
post
Get a training module (full content)
post
Reference Data
Get reference data (valid values)
post
Get reference data (valid values)
post
Domain Verification
Request domain verification
post
Verify a domain with a code
post
List verified domains
post
Lock a verified domain
post
Delete a domain
post
Get domain supply-chain scan
post
Request domain verification
post
Verify a domain with a code
post
List verified domains
post
Lock a verified domain
post
Delete a domain
post
Get domain supply-chain scan
post
Integrations
Get the outbound webhook configuration
post
Update the outbound webhook
post
Get webhook event types
post
Get the outbound webhook configuration
post
Update the outbound webhook
post
Get webhook event types
post
Reported Emails
Reported Email Settings
Get reported-email settings
post
Update reported-email analysis settings (Enterprise)
post
Update reported-email settings (general & notifications)
post
Update reported-email quarantine settings
post
Save quarantine connector credentials
post
Get reported-email settings
post
Update reported-email settings (general & notifications)
post
Update reported-email quarantine settings
post
Update reported-email analysis settings (Enterprise)
post
Save quarantine connector credentials
post
List reported (suspicious) emails
post
Attribute a reported email
post
Attribute multiple reported emails
post
Get the report-phish Outlook add-in manifest
post
Get reported message details
post
Clone a reported phish as a template
post
List reported (suspicious) emails
post
Attribute a reported email
post
Attribute multiple reported emails
post
Get the report-phish Outlook add-in manifest
post
Get reported message details
post
Clone a reported phish as a template
post
User Management
Add a platform user
post
Update a platform user
post
Delete a platform user
post
List platform users
post
Platform Settings
User Management
Add a platform user
post
Update a platform user
post
Delete a platform user
post
List platform users
post
Authentication & SSO
Get authentication settings (MFA + SSO state)
post
Update platform MFA requirement
post
Update / activate / deactivate Platform SSO
post
Update / activate / deactivate Learner SSO
post
Get authentication settings (MFA + SSO state)
post
Update platform MFA requirement
post
Update / activate / deactivate Platform SSO
post
Update / activate / deactivate Learner SSO
post
Email Delivery
Get email delivery settings
post
Create/update an email delivery provider (unified)
post
Delete an email delivery provider
post
Set the default email delivery provider
post
Get email delivery settings
post
Create/update an email delivery provider (unified)
post
Delete an email delivery provider
post
Set the default email delivery provider
post
Notifications
Get all notifications and dynamic identifiers
post
Get a notification email's HTML (with language)
post
Update a notification's text
post
Reset a notification to default
post
Get all notifications and dynamic identifiers
post
Get a notification email's HTML (with language)
post
Update a notification's text
post
Reset a notification to default
post
Phishing Settings
Get phishing settings
post
Update phishing education redirect
post
Update false-positive exclusions
post
Update the default phishing website
post
Get phishing settings
post
Update phishing education redirect
post
Update false-positive exclusions
post
Update the default phishing website
post
Language
Get language settings
post
Update a language setting
post
Get language settings
post
Update a language setting
post
Appearance
Get appearance settings
post
Update learner appearance settings
post
Get appearance settings
post
Update learner appearance settings
post
Training Settings
Get training settings
post
Update training settings
post
Get training settings
post
Update training settings
post
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
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 logs
post
View the audit log
post
View the SMTP delivery logs
post
View the audit log
post
Brand Protection
List brand identifiers
post
Add or update a brand identifier
post
Delete a brand identifier
post
List brand protection findings
post
Get one brand protection finding
post
List brand library images
post
Add an image to the brand library
post
Relabel or relink a brand library image
post
Delete a brand library image
post
List brand identifiers
post
Add or update a brand identifier
post
Delete a brand identifier
post
List brand protection findings
post
Get one brand protection finding
post
List brand library images
post
Add an image to the brand library
post
Relabel or relink a brand library image
post
Delete a brand library image
post
Domain Protection
List protected domains
post
Get a protected domain
post
List DMARC sending sources
post
Get DMARC volume series
post
Get domain protection notification settings
post
Check a protected domain's DNS record
post
Add a protected domain
post
Remove a protected domain
post
Pause or resume a protected domain
post
Update domain protection notification settings
post
Dismiss or restore a domain recommendation
post
Onboarding
Get onboarding / setup status + recommendations
post
Get onboarding / setup status + recommendations
post
Powered by
Copy Page
Reporting
Updated 3 months ago
Bulk-resend a campaign email
Campaign Results
Updated 3 months ago
Bulk-resend a campaign email
Campaign Results
