PhishingTackle MSP API (v1)

Download OpenAPI specification:Download

An API that interacts with PhishingTackle to provide data for your organisation

AllSubOrganisations

GetSubOrganisations

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Responses
200

Success

get/api/AllSubOrganisations
Request samples

EmailCampaign

GetEmailCampaign

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Request
query Parameters
campaignId
integer <int64>
Responses
200

Success

get/api/EmailCampaign
Request samples

CopyEmailCampaignToSubAccounts

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Request
Request Body schema:
campaignId
integer <int64>
subAccountOrgIds
Array of integers or null <int64>
Responses
200

Success

post/api/EmailCampaign
Request samples
{
  • "campaignId": 0,
  • "subAccountOrgIds": [
    ]
}

EmailCampaigns

GetEmailCampaigns

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Request
query Parameters
orgId
integer <int64>
Responses
200

Success

get/api/EmailCampaigns
Request samples

EmailCampaignsBetweenDates

GetEmailCampaignsBetweenDates

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Request
query Parameters
start
string <date-time>
end
string <date-time>
subOrgId
integer <int64>
Responses
200

Success

get/api/EmailCampaignsBetweenDates
Request samples

FailedPhishingTest

GetFailedPhishingTests

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Request
query Parameters
orgId
integer <int64>
Responses
200

Success

get/api/FailedPhishingTest
Request samples

License

GetLicenseDetails

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Responses
200

Success

get/api/License
Request samples

PhishingCampaignStats

GetEmailCampaignStats

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Request
query Parameters
campaignId
integer <int64>
Responses
200

Success

get/api/PhishingCampaignStats
Request samples

RecipientCount

GetRecipientCount

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Request
query Parameters
subOrganisationId
integer <int64>
Responses
200

Success

get/api/RecipientCount
Request samples

RecipientStats

GetRecipientStats

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Request
query Parameters
subOrgId
integer <int64>
page
integer <int32>
Responses
200

Success

get/api/RecipientStats
Request samples

Status

GetStatus

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Responses
200

Success

get/api/Status
Request samples

SubOrganisation

GetSubOrganisation

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Request
query Parameters
subOrganisationId
integer <int64>
Responses
200

Success

get/api/SubOrganisation
Request samples

TrainingCampaigns

GetCampaigns

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Request
query Parameters
orgId
integer <int64>
Responses
200

Success

get/api/TrainingCampaigns
Request samples

CopyCampaign

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Request
Request Body schema:
campaignId
integer <int64>
organisationIds
Array of integers or null <int64>
Responses
200

Success

post/api/TrainingCampaigns
Request samples
{
  • "campaignId": 0,
  • "organisationIds": [
    ]
}

TrainingCampaignStats

GetTrainingCampaignStats

SecurityOrgIdAuth and ApiKeyAuth and UserIdAuth
Request
query Parameters
campaignId
integer <int64>
subOrganisationId
integer <int64>
page
integer <int32>
Default: 1
Responses
200

Success

get/api/TrainingCampaignStats
Request samples