Fallax Campaigns API
The campaigns API from Fallax — 2 operation(s) for campaigns.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/fallax-io:fallax-io-campaigns-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Fallax Io Campaigns API
version: v1
description: 'Operations tagged campaigns across 2 of this provider''s published API definitions: fallax-io-openapi.json, fallax-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.fallax.io/v1
tags:
- name: Campaigns
paths:
/campaigns:
get:
operationId: listCampaigns
summary: List campaigns
description: Every simulation this workspace has created, each with its target, send, open, click, submit and report counts.
tags:
- Campaigns
security:
- bearerAuth: []
x-scope: read
parameters:
- schema:
type: string
description: Rows per page, 1 to 200. Defaults to 50. A page comes back with a `nextCursor` when there are more.
example: '50'
required: false
description: Rows per page, 1 to 200. Defaults to 50. A page comes back with a `nextCursor` when there are more.
name: limit
in: query
- schema:
type: string
description: The `nextCursor` from the previous page. Paging is by cursor rather than by offset, so rows written while you page are never skipped.
required: false
description: The `nextCursor` from the previous page. Paging is by cursor rather than by offset, so rows written while you page are never skipped.
name: cursor
in: query
- schema:
type: string
description: 'Only rows after this instant, exclusive. ISO 8601 or epoch milliseconds. This is the parameter a poll trigger uses: pass the timestamp of the newest row you have already handled.'
example: '2026-09-07T12:00:00Z'
required: false
description: 'Only rows after this instant, exclusive. ISO 8601 or epoch milliseconds. This is the parameter a poll trigger uses: pass the timestamp of the newest row you have already handled.'
name: since
in: query
- schema:
type: string
description: '`desc` (the default) for newest first, which is what a person reading a page wants. `asc` for oldest first, which is what anything resuming from a watermark wants: with `since` and a limit, an ascending page is the oldest rows you have not seen, so a backlog drains in order instead of the newest page hiding the rest.'
enum:
- desc
- asc
required: false
description: '`desc` (the default) for newest first, which is what a person reading a page wants. `asc` for oldest first, which is what anything resuming from a watermark wants: with `since` and a limit, an ascending page is the oldest rows you have not seen, so a backlog drains in order instead of the newest page hiding the rest.'
name: order
in: query
- schema:
type: string
description: '`draft`, `scheduled`, `running` or `completed`.'
enum:
- draft
- scheduled
- running
- completed
required: false
description: '`draft`, `scheduled`, `running` or `completed`.'
name: status
in: query
responses:
'200':
description: List campaigns
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignPage'
'400':
description: A parameter or body field the API cannot use. The message names the field.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: No key, an unknown key, or one that has been revoked.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: A read-only key was used on a write endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: 'No such endpoint, or no such row in this workspace. The two are deliberately indistinguishable from outside: another workspace''s ids must not be probeable.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: The path exists but not with that verb. `Allow` lists the verbs that work.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: More than 120 requests in a minute on one key. `Retry-After` says how long to wait. A poll every minute, and the paging behind it, is nowhere near this.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Our fault. Safe to retry.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.fallax.io/v1
/campaigns/{id}:
get:
operationId: getCampaign
summary: Get a campaign
description: One campaign and its counts.
tags:
- Campaigns
security:
- bearerAuth: []
x-scope: read
parameters:
- schema:
type: string
description: The id of the row.
example: r_2f8c
required: true
description: The id of the row.
name: id
in: path
responses:
'200':
description: Get a campaign
content:
application/json:
schema:
$ref: '#/components/schemas/Campaign'
'400':
description: A parameter or body field the API cannot use. The message names the field.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: No key, an unknown key, or one that has been revoked.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: A read-only key was used on a write endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: 'No such endpoint, or no such row in this workspace. The two are deliberately indistinguishable from outside: another workspace''s ids must not be probeable.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: The path exists but not with that verb. `Allow` lists the verbs that work.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: More than 120 requests in a minute on one key. `Retry-After` says how long to wait. A poll every minute, and the paging behind it, is nowhere near this.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Our fault. Safe to retry.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.fallax.io/v1
components:
schemas:
CampaignPage:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Campaign'
nextCursor:
type:
- string
- 'null'
description: Pass as `cursor` for the next page.
hasMore:
type: boolean
required:
- data
- nextCursor
- hasMore
Campaign:
type: object
properties:
id:
type: string
name:
type: string
status:
type: string
launchedAt:
type:
- string
- 'null'
format: date-time
completedAt:
type:
- string
- 'null'
format: date-time
createdAt:
type:
- string
- 'null'
format: date-time
stats:
type: object
properties:
targeted:
type: integer
sent:
type: integer
opened:
type: integer
clicked:
type: integer
submitted:
type: integer
replied:
type: integer
reported:
type: integer
required:
- targeted
- sent
- opened
- clicked
- submitted
- replied
- reported
required:
- id
- name
- status
- launchedAt
- completedAt
- createdAt
- stats
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- unauthorized
- forbidden
- not_found
- invalid_request
- method_not_allowed
- rate_limited
- internal
message:
type: string
required:
- code
- message
required:
- error
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: flx_
description: A workspace API key, created in Settings.
x-refined-from:
- fallax-io-openapi.json
- fallax-io-openapi.json