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 Campaigns API

The Campaigns API from IRONSCALES — 3 operation(s) for campaigns.

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

Tagged areas include Campaigns. 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 3 operations across 3 paths, and defines 6 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.

3 operations 3 paths 6 schemas 2 GET1 PUT

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 Campaigns 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 3

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

Campaigns 3
GET
/campaigns/{company_id}/details
Get campaigns details Each page contains 25 campaigns results Scopes: partner.all partner.company.view company.view Statuses mapping to UI values: Draft (0) - Draft Collecting (1) - Active Closed (2)…
Get campaigns details 6 params → 200400404403
PUT
/campaigns/{company_id}/participants-actions/
Perform action on campaign participants. Scopes: partner.company.edit company.edit
Perform participants action 2 params body → 200400403413
GET
/campaigns/{company_id}/participants-details
Get campaign participants details Each page contains 100 participants Scopes: partner.all partner.company.view company.view
Get campaign participants details 4 params → 200400404403

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CampaignParticipantsDetails (34 properties), CampaignDetails (23 properties), CampaignParticipantsDetailsPage (4 properties), ParticipantsActionsRequest (3 properties). Each schema is shown below with its type and property counts.

ParticipantsActionsFilters
object
1 property
CampaignDetailsPage
object
3 properties 3 required
ParticipantsActionsRequest
object
3 properties 2 required
CampaignDetails
object
23 properties 4 required
CampaignParticipantsDetails
object
34 properties
CampaignParticipantsDetailsPage
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ironscales-campaigns-api-openapi.yml Raw ↑

Other APIs IRONSCALES publishes across the network.

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

This is an independent, third-party profile of IRONSCALES Campaigns 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.