Sign in

v1

latestOpenAPI 3.1.02026-08-041529124.1 KB
Phishing

Get phishing campaign details

Retrieve detailed information about a specific phishing campaign including simulation summary

get/v2/phishing/campaigns/{campaignId}

Path parameters

campaignIdstring required

Campaign ID

Response

Successfully retrieved phishing campaign details

campaign_idstring

Unique identifier for the campaign

created_datestring date-time

Campaign creation date

distribution_interval'ALL_AT_ONCE' | 'DAY' | 'WEEK' | 'TWO_WEEKS' | 'MONTH' | 'THREE_MONTHS'

Interval between scenario distributions within each simulation

end_datestring date-time

Campaign end date (null for indefinite campaigns)

mode'SCHEDULED' | 'RECURRING'

Campaign mode

namestring

Name of the phishing campaign

recurring_interval'HOUR' | 'WEEK' | 'TWO_WEEKS' | 'MONTH' | 'THREE_MONTHS'

Interval for recurring campaigns (only present when mode = RECURRING)

start_datestring date-time

Campaign start date

status'DRAFT' | 'SCHEDULED' | 'IN_PROGRESS' | 'COMPLETED'

Current status of the campaign

target'ALL_USERS' | 'GROUPS'

Target audience for the campaign

Example response

{
  "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"
}