Skip to main content
Retrieve a list of phishing campaigns.
External DocumentationTo learn more, visit the Adaptive Security documentation.

​
Parameters

ParameterDescription
Page AfterThe pagination token used to specify the next page of results. Can be obtained from the page_after property from a previous response.
Page SizeThe maximum number of results to return per page.
Return All PagesAutomatically fetch all resources, page by page.

​
Example Output

{
	"campaigns": [
		{
			"campaign_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
			"name": "Quarterly Phish Test",
			"target": "GROUPS",
			"groups": [
				{
					"group_id": "f6a7b8c9-d0e1-2345-fabc-d67890123456",
					"name": "All Users"
				}
			],
			"scenarios": [
				{
					"scenario_id": "a7b8c9d0-e1f2-3456-abcd-e78901234567",
					"name": "Zoom Deepfake",
					"sender": "Zoom",
					"difficulty": "Hard",
					"spoofPageType": "DEEPFAKE_SPOOF_PAGE",
					"channel": "EMAIL",
					"attackVector": "LINK_CLICKED"
				}
			],
			"mode": "RECURRING",
			"status": "IN_PROGRESS",
			"created_date": "2025-06-01T13:19:13.402Z",
			"start_date": "2025-06-10T13:19:13.402Z",
			"end_date": "2025-08-10T13:19:13.402Z",
			"distribution_interval": "TWO_WEEKS",
			"recurring_interval": "MONTH",
			"simulations": [
				{
					"simulation_id": "c18f4e0b-5678-9abc-def0-123456789abc",
					"start_date": "2025-06-10T13:19:13.402Z",
					"end_date": "2025-07-10T13:19:13.402Z",
					"status": "COMPLETED"
				}
			]
		}
	],
	"page_after": "f3c7c8f3-1234-5678-9abc-def012345678"
}

​
Workflow Library Example

List Phishing Campaigns with Adaptive Security and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop