ActiveCampaign

ActiveCampaign Recipients API

The Recipients API from ActiveCampaign — 2 operation(s) for recipients.

GitHub OpenAPI

Operations 2

GET /sms/broadcasts/{broadcastId}/recipients ActiveCampaign Get Broadcast Recipients #
POST /sms/broadcasts/{broadcastId}/recipients/export ActiveCampaign Export Broadcast Recipients #

Documentation

📖
Documentation
https://developers.activecampaign.com/reference/overview
📖
Authentication
https://developers.activecampaign.com/reference/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/openapi/activecampaign-recipients-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/asyncapi/activecampaign-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-broadcast-message-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-broadcast-create-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-broadcast-update-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-broadcast-metrics-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-recipient-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-credits-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-ai-broadcast-request-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-structure/activecampaign-sms-broadcast-message-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-structure/activecampaign-sms-recipient-structure.json

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/graphql/activecampaign-graphql.md
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/examples/activecampaign-sms-broadcast-message-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/examples/activecampaign-sms-recipient-example.json
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/overlays/activecampaign-recipients-overlay.yaml

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/activecampaign-recipients-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

activecampaign-recipients-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ActiveCampaign SMS Broadcast Accounts Recipients API
  description: API for managing SMS broadcasts, lists, metrics, and AI-powered content generation in ActiveCampaign
  version: 3.0.0
  contact:
    name: ActiveCampaign Support
    url: https://www.activecampaign.com
  x-generated-from: documentation
servers:
- url: https://{yourAccountName}.api-us1.com/api/3
  description: US-based Users
  variables:
    yourAccountName:
      default: yourAccountName
security:
- ApiToken: []
tags:
- name: Recipients
paths:
  /sms/broadcasts/{broadcastId}/recipients:
    get:
      tags:
      - Recipients
      summary: ActiveCampaign Get Broadcast Recipients
      description: Fetch all contacts who were sent a specific broadcast
      operationId: getBroadcastRecipients
      parameters:
      - name: broadcastId
        in: path
        required: true
        description: Broadcast ID
        schema:
          type: integer
      - name: start_date
        in: query
        description: Start date (YYYY-MM-DD)
        schema:
          type: string
          format: date
      - name: end_date
        in: query
        description: End date (YYYY-MM-DD)
        schema:
          type: string
          format: date
      - name: filters[deliverability][]
        in: query
        description: Filter by deliverability status
        schema:
          type: array
          items:
            type: string
            enum:
            - deliveries
            - failures
      - name: filters[engagement][]
        in: query
        description: Filter by engagement type
        schema:
          type: array
          items:
            type: string
            enum:
            - clicks
            - replies
            - optOuts
      - name: search
        in: query
        description: Search contacts by name or phone
        schema:
          type: string
      - name: order[field]
        in: query
        description: Order by field
        schema:
          type: string
          enum:
          - name
          - phone
          - sentDate
          - clicks
          - deliverability
          - optOut
          - replies
      - name: offset
        in: query
        description: Offset for pagination
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: Number of items to return
        schema:
          type: integer
          default: 20
      responses:
        '200':
          description: Recipients retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipientsResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sms/broadcasts/{broadcastId}/recipients/export:
    post:
      tags:
      - Recipients
      summary: ActiveCampaign Export Broadcast Recipients
      description: Export recipient data as CSV including full contact records
      operationId: exportBroadcastRecipients
      parameters:
      - name: broadcastId
        in: path
        required: true
        description: Broadcast ID
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                start_date:
                  type: string
                  format: date
                end_date:
                  type: string
                  format: date
                engagement:
                  type: array
                  items:
                    type: string
                deliverability:
                  type: array
                  items:
                    type: string
                search:
                  type: string
                order:
                  type: object
      responses:
        '200':
          description: Export generated successfully
          content:
            text/csv:
              schema:
                type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Recipient:
      type: object
      properties:
        id:
          type: integer
          description: Contact ID
        name:
          type: string
        phoneNumber:
          type: string
        sentDate:
          type: string
          format: date-time
          description: Timestamp in CST
        clicks:
          type: integer
        deliverability:
          type: string
          enum:
          - delivered
          - failed
        replies:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              date:
                type: string
                format: date-time
                description: Timestamp in CST
        optOut:
          type: string
          enum:
          - 'yes'
          - 'no'
        details:
          type: object
          properties:
            errorCode:
              type: string
            errorSource:
              type: string
              enum:
              - ac
              - twilio
    RecipientsResponse:
      type: object
      properties:
        recipients:
          type: array
          items:
            $ref: '#/components/schemas/Recipient'
        meta:
          type: object
          properties:
            total:
              type: integer
            limit:
              type: integer
            offset:
              type: integer
  securitySchemes:
    ApiToken:
      type: apiKey
      name: Api-Token
      in: header
      description: Your ActiveCampaign API token