3.2 KiB
3.2 KiB
ActiveCampaign Routing Reference
App name: active-campaign
Base URL proxied: {account}.api-us1.com
API Path Pattern
/active-campaign/api/3/{resource}
Common Endpoints
Contacts
List Contacts
GET /active-campaign/api/3/contacts
Get Contact
GET /active-campaign/api/3/contacts/{contactId}
Create Contact
POST /active-campaign/api/3/contacts
Content-Type: application/json
{
"contact": {
"email": "user@example.com",
"firstName": "John",
"lastName": "Doe"
}
}
Update Contact
PUT /active-campaign/api/3/contacts/{contactId}
Delete Contact
DELETE /active-campaign/api/3/contacts/{contactId}
Tags
List Tags
GET /active-campaign/api/3/tags
Create Tag
POST /active-campaign/api/3/tags
Content-Type: application/json
{
"tag": {
"tag": "Tag Name",
"tagType": "contact"
}
}
Contact Tags
Add Tag to Contact
POST /active-campaign/api/3/contactTags
Content-Type: application/json
{
"contactTag": {
"contact": "1",
"tag": "1"
}
}
Remove Tag from Contact
DELETE /active-campaign/api/3/contactTags/{contactTagId}
Lists
List All Lists
GET /active-campaign/api/3/lists
Create List
POST /active-campaign/api/3/lists
Deals
List Deals
GET /active-campaign/api/3/deals
Create Deal
POST /active-campaign/api/3/deals
Content-Type: application/json
{
"deal": {
"title": "New Deal",
"value": "10000",
"currency": "usd",
"contact": "1",
"stage": "1"
}
}
Deal Stages & Pipelines
List Deal Stages
GET /active-campaign/api/3/dealStages
List Pipelines (Deal Groups)
GET /active-campaign/api/3/dealGroups
Automations
List Automations
GET /active-campaign/api/3/automations
Campaigns
List Campaigns
GET /active-campaign/api/3/campaigns
Users
List Users
GET /active-campaign/api/3/users
Accounts
List Accounts
GET /active-campaign/api/3/accounts
Custom Fields
List Fields
GET /active-campaign/api/3/fields
Notes
List Notes
GET /active-campaign/api/3/notes
Webhooks
List Webhooks
GET /active-campaign/api/3/webhooks
Pagination
Uses offset-based pagination:
GET /active-campaign/api/3/contacts?limit=20&offset=0
Parameters:
limit- Results per page (default: 20)offset- Starting index
Response includes meta with total:
{
"contacts": [...],
"meta": {
"total": "150"
}
}
Notes
- All endpoints require
/api/3/prefix - Request bodies use singular resource names (e.g.,
{"contact": {...}}) - IDs returned as strings
- Rate limit: 5 requests per second per account
- DELETE returns 200 OK (not 204)