v1
latestOpenAPI 3.1.02026-08-041529124.1 KBPhishing
List phishing campaigns
Retrieve a paginated list of phishing campaigns
get/v2/phishing/campaigns
Query parameters
page_afterstring
Page cursor
page_sizeinteger
Page size
Response
Successfully retrieved phishing campaigns
Example response
{
"campaigns": [
{
"campaign_id": "f3c7c8f3-1234-5678-9abc-def012345678",
"created_date": "2025-06-01T13:19:13.402Z",
"distribution_interval": "TWO_WEEKS",
"end_date": "2025-08-10T13:19:13.402Z",
"groups": [
{
"group_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "All Users"
}
],
"mode": "RECURRING",
"name": "Quarterly Phish Test",
"recurring_interval": "MONTH",
"scenarios": [
{
"attack_vector": "LINK_CLICKED",
"channel": "EMAIL",
"difficulty": "HARD",
"name": "Zoom Deepfake",
"scenario_id": "s-zoom-123",
"sender": "Zoom",
"spoof_page_type": "DEEPFAKE_SPOOF_PAGE"
}
],
"simulations": [
{
"end_date": "2025-08-10T13:19:13.402Z",
"simulation_id": "c18f4e0b-5678-9abc-def0-123456789abc",
"start_date": "2025-07-10T13:19:13.402Z",
"status": "COMPLETED"
}
],
"start_date": "2025-06-10T13:19:13.402Z",
"status": "IN_PROGRESS",
"target": "GROUPS"
}
],
"page_after": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}