Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adaptive Security Phishing API

BETAPhishing campaign and simulation management endpoints

Adaptive Security Phishing API is one of 5 APIs that Adaptive Security publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Phishing. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.

This API exposes 5 operations across 5 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against a single base URL, https://api.adaptivesecurity.com.

5 operations 5 paths 13 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.adaptivesecurity.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Adaptive Security Phishing API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer-token). By default, every request must be authenticated.

  • bearer-token — API authentication token obtained from the Adaptive Admin portal (Settings → API Tokens). Include the token in the Authorization header as: Bearer YOURTOKEN

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Phishing 5

BETA Phishing campaign and simulation management endpoints

GET
/v2/phishing/campaigns
List phishing campaigns
listPhishingCampaigns 2 params → 200400401429500
GET
/v2/phishing/campaigns/enrollments
Get phishing enrollments
getPhishingEnrollments 5 params → 200401429500
GET
/v2/phishing/campaigns/{campaignId}
Get phishing campaign details
getPhishingCampaign 1 param → 200401404500
GET
/v2/phishing/campaigns/{campaignId}/simulations
List simulations for campaign
listCampaignSimulations 3 params → 200401404500
GET
/v2/phishing/simulations/{simulationId}
Get simulation execution details
getSimulation 1 param → 200401404500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are PhishingEnrollmentDto (18 properties), PhishingCampaignDto (13 properties), PhishingSimulationDto (7 properties), PhishingCampaignScenarioDto (7 properties). Each schema is shown below with its type and property counts.

PhishingCampaignGroupDto
object
Groups associated with the phishing campaign
2 properties
PhishingCampaignScenarioDto
object
Phishing campaign scenario information
7 properties
PhishingCampaignDto
object
Phishing campaign information representing the logical campaign configuration
13 properties
PhishingEnrollmentDto
object
Phishing enrollment details for a user in a specific simulation execution
18 properties
PhishingEnrollmentListResponseDto
object
Paginated list of phishing enrollments
2 properties
ValidationErrorResponseDto
object
Error response for validation failures with field-level details
5 properties 5 required
PhishingEnrollmentUserDto
object
User information for phishing enrollment
2 properties
PhishingSimulationListResponseDto
object
Paginated list of phishing simulation executions
2 properties
PhishingCampaignListResponseDto
object
Paginated list of phishing campaigns
2 properties
ErrorDetail
object
Field-level validation error details
2 properties 2 required
PhishingSimulationSummaryDto
object
Summary information for a phishing simulation execution
4 properties
PhishingSimulationDto
object
Detailed phishing simulation execution information
7 properties
ErrorResponseDto
object
Standard error response format for all API errors
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adaptive-security-phishing-api-openapi.yml Raw ↑

Other APIs Adaptive Security publishes across the network.

Adaptive Security Audit Logs API
Adaptive Security Groups API
Adaptive Security Training API
Adaptive Security Users API