v1

latestOpenAPI 3.1.02026-08-041529124.1 KB

Phishing

List simulations for campaign

Retrieve a paginated list of simulation executions for a specific campaign

get/v2/phishing/campaigns/{campaignId}/simulations

Path parameters

campaignIdstring required

Campaign ID

Query parameters

page_afterstring

Page cursor

page_sizeinteger

Page size

Response

Successfully retrieved simulation executions

page_afterstring

Cursor for the next page

Example response

{
  "page_after": "c18f4e0b-dddd-eeee-ffff-0fb2",
  "simulations": [
    {
      "campaign_id": "3d65f3b0-9abc-def0-1234-56789abcdef0",
      "distribution_interval": "TWO_WEEKS",
      "end_date": "2025-09-10T13:19:13.402Z",
      "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"
        }
      ],
      "simulation_id": "c18f4e0b-5678-9abc-def0-123456789abc",
      "start_date": "2025-08-10T13:19:13.402Z",
      "status": "IN_PROGRESS"
    }
  ]
}