How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IRONSCALES SAT API

The SAT API from IRONSCALES — 15 operation(s) for sat.

IRONSCALES SAT API is one of 10 APIs that IRONSCALES publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 18 operations across 15 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://appapi.ironscales.com/appapi.

18 operations 15 paths 52 schemas 1 DELETE12 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://appapi.ironscales.com/appapi
Authentication
API Key
Resource Areas
1

Authentication & Security 1

IRONSCALES SAT API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (JWT). By default, every request must be authenticated.

Paths & Operations 18

Across 15 paths, the API surfaces 18 operations — 1 DELETE, 12 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

SAT 18
GET
/sat/{company_id}/campaigns/
Scopes: company.view partner.company.view
Get Campaigns List 11 params → 200400401403404429500
POST
/sat/{company_id}/campaigns/
Create a new draft campaign.
Create Draft Campaign 1 param body → 201400401403404429500
GET
/sat/{company_id}/campaigns/lookup/
Return a lightweight id/name list of campaigns.
Get Campaigns Lookup 11 params → 200400401403404429500
GET
/sat/{company_id}/campaigns/{campaign_id}/
Scopes: company.view partner.company.view
Get Campaign Details 2 params → 200401403404429500
DELETE
/sat/{company_id}/campaigns/{campaign_id}/
Delete a campaign. Scopes: company.edit partner.company.edit
Delete Campaign 2 params → 204401403404429500
POST
/sat/{company_id}/campaigns/{campaign_id}/approve/
Approve a draft campaign.
Approve Campaign 2 params → 200400401403404429500
POST
/sat/{company_id}/campaigns/{campaign_id}/stop/
Stop an active campaign.
Stop Campaign 2 params → 200400401403404429500
GET
/sat/{company_id}/cta/
Retrieve a paginated list of call for action pages available for the specified company. The endpoint returns system pages, public pages, company-owned pages, and brand owner pages (if the company is…
Get call for action pages 4 params → 200400404403429
GET
/sat/{company_id}/landing-pages/
Get landing pages for a company.
Get landing pages 6 params → 200400404403429
GET
/sat/{company_id}/participants/
Get list of campaign participants grouped by categories.
Get Participants List 1 param → 200400401403404429500
POST
/sat/{company_id}/participants/
Calculate participants based on include/exclude filters.
Calculate Participants 1 param body → 200400401403404429500
POST
/sat/{company_id}/participants/search/
Search for campaign participants.
Search Participants 1 param body → 200400401403404429500
GET
/sat/{company_id}/setup/
Retrieve campaign setup and settings data for the specified company. This endpoint provides configuration data needed for campaign creation and management, including license limits, training content…
Get Campaign Setup 2 params → 200404403429
GET
/sat/{company_id}/templates/
Get templates list.
Get Templates List 11 params → 200400401403404429500
GET
/sat/{company_id}/templates/categories/
Get template categories. Scopes: company.view partner.company.view
Get Template Categories 1 param → 200400401403404429500
GET
/sat/{company_id}/trainings/
Get training list.
Get Trainings List 5 params → 200400401403404429500
GET
/sat/{company_id}/trainings/providers/
Get training providers.
Get Training Providers 1 param → 200401403404429500
GET
/sat/{company_id}/trainings/{training_id}/preview/
Scopes: company.view partner.company.view
Get Training Preview URL 3 params → 200401403404429500

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are CampaignDetailsResponse (34 properties), CampaignCreateRequest (29 properties), TemplateContent (19 properties), Template (16 properties). Each schema is shown below with its type and property counts.

TrainingCampaignData
objectnull
Training-specific campaign data
6 properties
LocaleBannerContent
object
1 property 1 required
Template
object
16 properties 1 required
CampaignCreateRequest
object
29 properties 6 required
TemplateContent
object
19 properties 3 required
LocaleContent
object
2 properties 2 required
TrainingItem
object
5 properties 2 required
ParticipantsSearchResponse
object
1 property
CampaignDetailsResponse
object
34 properties
LandingPage
objectnull
3 properties
ParticipantCandidate
object
4 properties 4 required
Language
object
7 properties 7 required
TrainingProvidersResponse
object
1 property 1 required
TrainingReminderContent
objectnull
List of training reminder content
2 properties 2 required
CampaignSetup
object
12 properties
CampaignLookupResponse
object
4 properties
CampaignTrainingContent
object
6 properties
ManagerNotificationSettingsCreate
objectnull
Manager notification settings. If enabled is False or missing, manager notifications will not be configured.
6 properties
ParticipantsSearchRequest
object
1 property 1 required
CampaignNotification
objectnull
List of campaign notifications
3 properties 1 required
LandingPagesData
object
8 properties 6 required
TrainingsListResponse
object
4 properties 4 required
Category
object
2 properties
ParticipantsCalculateResponse
object
2 properties
TemplateCategoriesResponse
object
1 property 1 required
ParticipantsCalculateRequest
object
2 properties 1 required
TemplateCategory
object
2 properties 2 required
CampaignListResponseItem
object
11 properties
Segment
object
2 properties
CampaignLookupResponseItem
object
2 properties
TrainingProvider
object
4 properties 4 required
CampaignCreateResponse
object
1 property 1 required
ManagerNotificationBanner
objectnull
Manager notification banner settings
1 property 1 required
TemplatesListResponse
object
4 properties 4 required
ParticipantsCalculateBase
objectnull
Participant exclusion criteria
9 properties
Training
object
11 properties 2 required
ParticipantsCalculateResponseMeta
object
Get metadata for the response. Args: content: Dictionary containing participants data and queryset. Returns: Dictionary containing metadata (count, localeids,…
3 properties 1 required
CampaignTrainingContentItem
object
6 properties
LandingPages
object
4 properties 4 required
ParticipantsListResponse
object
10 properties
CallForAction
object
4 properties 4 required
CampaignStatistic
object
4 properties 4 required
CallForActionData
object
List of call for action pages for the current page
9 properties 8 required
CampaignManagerNotificationSettings
object
6 properties
ParticipantItem
object
3 properties 2 required
AwarenessLevelsDistribution
object
Get awareness levels distribution. Args: content: Dictionary containing participants queryset. Returns: Dictionary with awareness level distribution (beginner,…
3 properties
Scenario
object
5 properties
BaseTrainingSubtitle
object
2 properties
ParticipantsCalculateInclude
object
Participant selection criteria
10 properties 1 required
CampaignListResponse
object
4 properties
LandingPageContent
object
3 properties
ManagerReportEmail
objectnull
Manager report email settings
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ironscales-sat-api-openapi.yml Raw ↑

Other APIs IRONSCALES publishes across the network.

IRONSCALES MCP Server
IRONSCALES Authorization API
IRONSCALES Campaigns API
IRONSCALES Deepfake API
IRONSCALES Emails API
IRONSCALES Incident API
IRONSCALES Mailboxes API
IRONSCALES Mitigation API
IRONSCALES Settings API
Where this information came from

This is an independent, third-party profile of IRONSCALES SAT API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.