Campaign Refinery API Documentation

This is the complete API documentation for connecting to the Campaign Refinery API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Campaign Refinery: Email marketing and automation platform for contacts, tags, goals, forms, broadcasts, and API-driven email utilities. Keep reading to get started.

Quickstart

Before you run your first Campaign Refinery request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Campaign Refinery connection — create or choose one in Connections. Note its connectionId.

Every Campaign Refinery action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/campaignRefinery/latest/actions/{actionSlug}

You need a MindCloud API Key and a Campaign Refinery connection. Then call an action such as Export Points Balance CSV:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/campaignRefinery/latest/actions/export-points-balance-csv" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Campaign Refinery account that should run the action. MindCloud stores and refreshes the Campaign Refinery credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Campaign Refinery actions

All 35 published actions for this Campaign Refinery version. Each page documents the endpoint, arguments, and response controls.

• PUTAdd Form to Contact
• PUTAdd Goal to Contact
• PUTAdd Tag to Contact
• POSTCreate Attribute
• POSTCreate Attribute Group
• POSTCreate Contact
• POSTCreate Form
• POSTCreate Goal
• POSTCreate Tag
• DELETEDelete Form
• DELETEDelete Tag from Contact
• GETExport Points Balance CSV
• GETGet Attribute by Name
• GETGet Attribute Groups
• GETGet Attributes
• GETGet Broadcast Stats
• GETGet Broadcasts
• GETGet Contact by Email
• GETGet Contact Tags
• GETGet Contacts
• GETGet Daily Points
• GETGet Form by Name
• GETGet Forms
• GETGet Goal by ID
• GETGet Goal by Name
• GETGet Goals
• GETGet Tag by Name
• GETGet Tags
• GETGet Top Ranked Contacts
• POSTSubscribe Contact
• PUTUpdate Attribute
• PUTUpdate Contact
• PUTUpdate Form
• PUTUpdate Goal
• PUTUpdate Tag

Related apps

More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.

Google FormsMailchimpCalendlyWebflowGoogle AdsActiveCampaignBrevoMailerLite