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

PixieBrix Campaigns API

The campaigns API from PixieBrix — 4 operation(s) for campaigns.

PixieBrix Campaigns API is one of 31 APIs that PixieBrix 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, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 4 operations across 4 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.pixiebrix.com.

4 operations 4 paths 2 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.pixiebrix.com/api/
Resource Areas
1

Paths & Operations 4

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

campaigns 4
GET
/api/campaigns/{campaign_pk}/jobs/{id}/
Return the status and result of a campaign engagement report job by its id.
retrieveCampaignEngagementJob 2 params → 200
GET
/api/campaigns/{campaign_pk}/databases/
Return the databases accessible to the members of a campaign, along with the campaign group permissions on each.
listCampaignDatabases 3 params → 200
POST
/api/campaigns/{campaign_pk}/jobs/
Start a new campaign engagement report job, or redirect to the existing job if one is already in progress for the campaign.
createCampaignEngagementJob 1 param body → 201
POST
/api/campaigns/{campaign_pk}/emails/jobs/
Queue a batch email job for a campaign, sending either registration invitations or activation reminders to its members based on the requested type.
createCampaignEmailJob 1 param body → 201

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are CampaignDatabase (11 properties), Job (2 properties). Each schema is shown below with its type and property counts.

Job
object
2 properties 1 required
CampaignDatabase
object
11 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pixiebrix-campaigns-api-openapi.yml Raw ↑

Other APIs PixieBrix publishes across the network.

PixieBrix Activity API
PixieBrix Audit API
PixieBrix Bricks API
PixieBrix Config API
PixieBrix Control Rooms API
PixieBrix Copilot API
PixieBrix Databases API
PixieBrix Deployments API
PixieBrix Events API
PixieBrix Groups API
PixieBrix Health API
PixieBrix Identify API
Where this information came from

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