abm-dev

abm-dev Campaigns API

Orchestrate multi-step outreach campaigns that combine people-finding, enrichment, and CRM writeback

Documentation GitHub OpenAPI

Operations 9

POST /v1/campaigns/preview Preview campaign #

POST /v1/campaigns/confirm Confirm and start campaign #

GET /v1/campaigns List campaigns #

GET /v1/campaigns/{id} Get campaign status #

DELETE /v1/campaigns/{id} Cancel campaign #

GET /v1/campaigns/{id}/stream SSE progress stream #

GET /v1/campaigns/{id}/results Get campaign results with candidates #

POST /v1/campaigns/{id}/approve Approve candidates #

POST /v1/campaigns/{id}/writeback Trigger CRM writeback #

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/abm-dev:abm-dev-campaigns-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 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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  version: 2.0.0
  title: ABM.dev Campaigns API
  description: The account-based marketing API for AI agents. Search, Source, Enrich, and Create over B2B people and companies, every field cited with a source and confidence score.
  contact:
    name: ABM.dev
    url: https://abm.dev
servers:
- url: https://api.abm.dev
  description: Production
- url: https://api-dev.abm.dev
  description: Staging
security:
- ApiKeyAuth: []
tags:
- name: Campaigns
  description: Orchestrate multi-step outreach campaigns that combine people-finding, enrichment, and CRM writeback
paths:
  /v1/campaigns/preview:
    post:
      operationId: previewCampaign
      tags:
      - Campaigns
      summary: Preview campaign
      description: Preview a campaign before launching — returns estimated credit cost, target count, and validation warnings.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - source
              properties:
                name:
                  type: string
                  description: Campaign name
                source:
                  type: object
                  description: Target source (CRM list, upload, or manual)
                  properties:
                    type:
                      type: string
                      enum:
                      - hubspot_list
                      - upload
                      - manual
                    list_id:
                      type: string
                    upload_id:
                      type: string
                      format: uuid
                    companies:
                      type: array
                      items:
                        type: object
                roles:
                  type: array
                  items:
                    type: string
                options:
                  type: object
                  properties:
                    enrich:
                      type: boolean
                      default: true
                    auto_approve:
                      type: boolean
                      default: false
                    create_in_crm:
                      type: boolean
                      default: false
                    max_per_role:
                      type: integer
                      default: 3
      responses:
        '200':
          description: Campaign preview with estimates
          content:
            application/json:
              schema:
                type: object
                properties:
                  preview_id:
                    type: string
                    format: uuid
                  total_companies:
                    type: integer
                  estimated_credits:
                    type: integer
                  warnings:
                    type: array
                    items:
                      type: string
  /v1/campaigns/confirm:
    post:
      operationId: confirmCampaign
      tags:
      - Campaigns
      summary: Confirm and start campaign
      description: Confirm a previewed campaign and begin processing. Credits are reserved at this point.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - preview_id
              properties:
                preview_id:
                  type: string
                  format: uuid
      responses:
        '202':
          description: Campaign started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
  /v1/campaigns:
    get:
      operationId: listCampaigns
      tags:
      - Campaigns
      summary: List campaigns
      description: Return a paginated list of campaigns for the current organization.
      parameters:
      - name: status
        in: query
        schema:
          type: string
          enum:
          - draft
          - processing
          - completed
          - failed
          - cancelled
      - name: limit
        in: query
        schema:
          type: integer
          default: 20
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Paginated list of campaigns
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Campaign'
                  total:
                    type: integer
  /v1/campaigns/{id}:
    get:
      operationId: getCampaign
      tags:
      - Campaigns
      summary: Get campaign status
      description: Retrieve current status, progress, and summary for a campaign.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Campaign details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: cancelCampaign
      tags:
      - Campaigns
      summary: Cancel campaign
      description: Cancel a running campaign. In-progress jobs will complete but no new jobs will be started.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Campaign cancelled
        '404':
          $ref: '#/components/responses/NotFound'
  /v1/campaigns/{id}/stream:
    get:
      operationId: streamCampaign
      tags:
      - Campaigns
      summary: SSE progress stream
      description: Stream real-time progress updates for a campaign via Server-Sent Events.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Server-Sent Events stream
          content:
            text/event-stream:
              schema:
                type: string
  /v1/campaigns/{id}/results:
    get:
      operationId: getCampaignResults
      tags:
      - Campaigns
      summary: Get campaign results with candidates
      description: Retrieve all candidates found by the campaign, grouped by company.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: limit
        in: query
        schema:
          type: integer
          default: 50
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Campaign results
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PersonFinderCandidate'
                  total:
                    type: integer
        '404':
          $ref: '#/components/responses/NotFound'
  /v1/campaigns/{id}/approve:
    post:
      operationId: approveCampaignCandidates
      tags:
      - Campaigns
      summary: Approve candidates
      description: Approve selected candidates from a campaign for enrichment and CRM writeback.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                candidate_ids:
                  type: array
                  items:
                    type: string
                  description: Specific candidate IDs to approve. Omit to approve all.
                enrich:
                  type: boolean
                  default: true
                create_in_crm:
                  type: boolean
                  default: false
      responses:
        '200':
          description: Candidates approved
        '404':
          $ref: '#/components/responses/NotFound'
  /v1/campaigns/{id}/writeback:
    post:
      operationId: campaignWriteback
      tags:
      - Campaigns
      summary: Trigger CRM writeback
      description: Push all approved campaign candidates to the connected CRM.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Writeback results
          content:
            application/json:
              schema:
                type: object
                properties:
                  written:
                    type: integer
                  skipped:
                    type: integer
                  errors:
                    type: array
                    items:
                      type: object
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: Resource not found
  schemas:
    Campaign:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
          - draft
          - processing
          - completed
          - failed
          - cancelled
        source_type:
          type: string
          enum:
          - hubspot_list
          - upload
          - manual
        total_companies:
          type: integer
        companies_completed:
          type: integer
        total_candidates_found:
          type: integer
        credits_used:
          type: integer
        created_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
    PersonFinderCandidate:
      type: object
      properties:
        name:
          type: string
        title:
          type: string
        matchedRole:
          type: string
          description: Which searched role this candidate matched
        confidence:
          type: number
          format: float
          description: Match confidence score (0-1)
        email:
          type: string
          format: email
        linkedinUrl:
          type: string
          format: uri
        location:
          type: string
        sources:
          type: array
          items:
            type: string
          description: Data sources that found this candidate
        hubspotContactId:
          type: string
          description: HubSpot contact ID if created in CRM
        enrichmentJobId:
          type: integer
          description: Enrichment job ID if enrich option was enabled
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Clerk-issued JWT. Used for dashboard/portal requests and for the `/v1/organizations/signup` bootstrap endpoint.
x-tagGroups:
- name: Core API
  tags:
  - Enrichment
  - People Finder
  - Campaigns
- name: Configuration
  tags:
  - Field Configuration
  - Enrichment Config
- name: Integrations
  tags:
  - LinkedIn
  - CRM
  - Webhooks
- name: Account
  tags:
  - Organization
  - Health