ADadaptivesecurity
Phishing

Get simulation execution details

Changed on

Retrieve detailed information about a specific simulation execution

Required permission: phishing:read

get/v2/phishing/simulations/{simulationId}

Request

  • Base URL
    https://api.adaptivesecurity.com
  • URL
    https://api.adaptivesecurity.com/v2/phishing/simulations/{simulationId}
  • Auth
    HTTP bearer

Path parameters

simulationIdstring required

Simulation Execution ID

Response

Successfully retrieved simulation execution details

campaign_idstring

Campaign identifier

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

Interval between scenario distributions for this simulation

end_datestring date-time nullable

End date of this simulation execution

simulation_idstring

Unique identifier for the simulation execution

start_datestring date-time nullable

Start date of this simulation execution

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

Current status of this simulation execution

Example response

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

Changes

  • 41f0ca9c551aRevision changes
    • warning

      added the new ATTACHMENT_OPENED enum value to the // response property for the response status

    • warning

      added the new QR_CODE_SCANNED enum value to the // response property for the response status

    • info

      removed the INBOUND_PHONE_CALL enum value from the // response property for the response status

  • 9ce896e97db1Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property became nullable for the status