API Reference
Integrate PhishFortress with your security stack using our comprehensive API
Quick Start
Get Started with Authentication
Learn how to authenticate and make your first API call
Create Your First Campaign
Step-by-step guide to creating a phishing campaign via API
Manage Users Programmatically
Import and manage users using the Users API
Set Up Webhooks
Configure real-time notifications for your application
Authentication
Core
Learn how to authenticate with the PhishFortress API using API keys and OAuth 2.0
12 min read
Key endpoints:
POST /auth/token
GET /auth/verify
Campaigns API
Campaigns
Create, manage, and analyze phishing campaigns programmatically
15 min read
Key endpoints:
GET /campaigns
POST /campaigns
+1 more endpoints
Templates API
New
Templates
Access and modify phishing templates through the API
10 min read
Key endpoints:
GET /templates
POST /templates
+1 more endpoints
Users API
Users
Manage users, groups, and permissions programmatically
14 min read
Key endpoints:
GET /users
POST /users
+1 more endpoints
Reports API
Analytics
Generate and retrieve detailed campaign reports and analytics
8 min read
Key endpoints:
GET /reports
GET /reports/{id}
+1 more endpoints
Webhooks
New
Integration
Set up real-time notifications for campaign events and user interactions
16 min read
Key endpoints:
GET /webhooks
POST /webhooks
+1 more endpoints
Training API
Training
Manage security awareness training modules and assignments
11 min read
Key endpoints:
GET /training
POST /training/assign
+1 more endpoints
Organizations API
Organizations
Configure organization settings and manage multi-tenant deployments
9 min read
Key endpoints:
GET /organizations
PUT /organizations/{id}
+1 more endpoints
API Resources
Additional resources to help you work with the PhishFortress API:
Developer Tools
Tools and utilities to enhance your development experience:
Interactive API Explorer
Test API endpoints directly from your browser with our interactive API explorer. Send requests, view responses, and generate code snippets.
Open API Explorer