PRIMIS

PRIMIS Campaign API

Campaign API

GitHub OpenAPI

Documentation

📖
APIReference
https://api.primis.cx/api-docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/openapi/primis-campaign-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/conventions/primis-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/errors/primis-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/data-model/primis-data-model.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/lifecycle/primis-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/conformance/primis-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/sandbox/primis-sandbox.yml

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.
All 92 tools

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/primis-campaign-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

primis-campaign-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  title: REST Auth Campaign API
  version: 1.1.0
  description: Primis API docs
servers:
- url: https://api.primis.cx
  description: Production server
- url: https://api.qa.primis.cx
  description: QA Server
tags:
- name: Campaign
  description: Campaign API
paths:
  /campaigns:
    post:
      tags:
      - Campaign
      summary: Create retailer's campaigns
      responses:
        '200':
          description: OK
        '500':
          description: Server Error
  /campaigns/default:
    get:
      tags:
      - Campaign
      summary: Get a retailer's default campaign
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
        '500':
          description: Server Error
  /campaigns/{id}:
    get:
      tags:
      - Campaign
      summary: Get a retailer's campaign
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
        description: Id of the campaign
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
        '500':
          description: Server Error
    put:
      tags:
      - Campaign
      summary: Update a retailer's campaign
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
        description: Id of the campaign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Campaign'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
        '500':
          description: Server Error
  /campaigns/{id}/{imageType}:
    put:
      tags:
      - Campaign
      summary: Update a retailer's campaign image
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
        description: Id of the campaign
      - in: path
        name: imageType
        schema:
          type: string
          enum:
          - logo
          - banner
        required: true
        description: Type of image
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Campaign'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
        '500':
          description: Server Error
components:
  schemas:
    Campaign:
      properties:
        id:
          title: Campaign.id
          type: string
        retailerId:
          title: Campaign.retailerId
          type: string
        name:
          title: Campaign.name
          type: string
        description:
          title: Campaign.description
          type: string
        slogan:
          title: Campaign.slogan
          type: string
        variants:
          type: array
        productRecommendations:
          items:
            title: Campaign.productRecommendations.[]
            type: string
          title: Campaign.productRecommendations
          type: array
        productRecommendationsEnabled:
          title: Campaign.productRecommendationsEnabled
          type: boolean
        status:
          type: string
          enum:
          - active
          - inactive
          - deleted
          title: Campaign.status
      additionalProperties: false
      title: Campaign
      type: object
  securitySchemes:
    bearerAuth:
      type: https
      scheme: bearer
      bearerFormat: JWT