v1

latestOpenAPI 3.1.02026-08-041529124.1 KB
Phishing

Get phishing enrollments

Retrieve details about phishing enrollments with campaign, simulation, and user filters

get/v2/phishing/campaigns/enrollments

Query parameters

user_idstring

User ID

campaign_idstring

Phishing campaign ID

simulation_idstring

Simulation execution ID

page_afterstring

Page cursor

page_sizeinteger

Page size

Response

Successfully retrieved phishing enrollment details

page_afterstring

Cursor for the next page

Example response

{
  "enrollments": [
    {
      "campaign_id": "3d65f3b0-9abc-def0-1234-56789abcdef0",
      "clicked_at": "2025-06-10T15:05:38.000Z",
      "credentials_entered_at": "2025-06-10T15:07:38.000Z",
      "deep_fake_played_at": "2025-06-10T15:08:38.000Z",
      "delivered_at": "2025-06-10T15:02:38.000Z",
      "enrollment_id": "d0e1f2a3-b4c5-6789-defa-b01234567890",
      "failed_at": "2025-06-10T15:07:38.000Z",
      "ip": "192.168.1.100",
      "ip_location": "Philadelphia, PA",
      "opened_at": "2025-06-10T15:04:38.000Z",
      "phone_number_called_at": "2025-06-10T15:08:38.000Z",
      "qr_code_scanned_at": "2025-06-10T15:08:38.000Z",
      "reported_at": "2025-06-10T15:09:38.000Z",
      "scenario_id": "a7b8c9d0-e1f2-3456-abcd-e78901234567",
      "scheduled_at": "2025-06-10T15:02:38.000Z",
      "simulation_id": "c18f4e0b-5678-9abc-def0-123456789abc",
      "text_replied_at": "2025-06-10T15:06:38.000Z",
      "user": {
        "email": "john.smith@example.com",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "page_after": "f2a3b4c5-d6e7-8901-fabc-d23456789012"
}