Explore the Active Campaign API data model

See how the various Active Campaign endpoints relate to each other, using our handy Entity Relationship Diagram

Pulling data from the Active Campaign API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only sync your Active Campaign API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

Contact

Documentation: https://developers.activecampaign.com/reference/contact

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Email string - -
Phone string - -
FirstName string - -
LastName string - -
Deleted boolean - -
Cdate datetime -
  • 21 Oct 2022 cdate is short for 'created date'
Udate datetime -
  • 21 Oct 2022 udate is short for 'updated date'
Organization long - -
SegmentioID int - -
BouncedHard boolean - -
BouncedSoft boolean - -
BouncedDate string - -
Ip long - -
Ua string - -
Hash string - -
SocialdataLastcheck string - -
EmailLocal string - -
EmailDomain string - -
Sentcnt int - -
RatingTstamp string - -
Gravatar int - -
Anonymized int - -
Adate datetime - -
Edate datetime - -
DeletedAt datetime - -
CreatedBy long - -
UpdatedBy long - -
EmailEmpty boolean - -
MppTracking int - -

ContactCustomField

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Title string - -
Descript string - -
Type string - -
Isrequired int - -
Perstag string - -
Defval string - -
ShowInList int - -
Rows int - -
Cols int - -
Visible int - -
Service string - -
Ordernum int - -
Cdate datetime - -
Udate datetime - -

ContactCustomFieldValue

Documentation: https://developers.activecampaign.com/reference/list-all-custom-field-values

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Owner int - -
Contact long Contact → ID -
Field long ContactCustomField → ID -
Value string -
  • 16 Nov 2022 In the case of multi-options, the string comes down as double-pipe-delimited (||)
Cdate datetime - -
Udate datetime - -

ContactList

Documentation: https://developers.activecampaign.com/reference/retrieve-contact-list-memberships

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Contact long Contact → ID -
List long List → ID -
Form long - -
Seriesid long - -
Sdate datetime - -
Udate datetime - -
Status int - -
Responder int - -
Sync int - -
Unsubreason string - -
Campaign string - -
Message string - -
FirstName string - -
LastName string - -
Sourceid int - -
AutosyncLog string - -
Ip4Last long - -
Ip4Unsub long - -
CreatedTimestamp datetime - -
UpdatedTimestamp datetime - -
Automation long Automation → ID
  • 8 Jun 2023 Not confirmed the FK

Deal

Documentation: https://developers.activecampaign.com/reference/deal

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Description string - -
Owner int - -
Contact long Contact → ID -
Organization int - -
Group int - -
Stage int - -
Title string - -
Percent decimal - -
Cdate datetime - -
Mdate datetime - -
Nextdate datetime - -
Nexttaskid int - -
Value int - -
Currency string - -
WinProbability int - -
WinProbabilityMdate datetime - -
Status int - -
Nextdealid int - -
Edate string - -
IsDisabled boolean - -
Account string - -
Customeraccount string - -

DealCustomField

Documentation: https://developers.activecampaign.com/reference/retrieve-all-custom-deal-field-meta

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
FieldLabel string - -
FieldType string - -
FieldDefaultCurrency string - -
IsFormVisible int - -
IsRequired int - -
DisplayOrder int - -
Personalization string - -
KnownFieldID int - -
HideFieldFlag int - -
CreatedTimestamp datetime - -
UpdatedTimestamp datetime - -

DealCustomFieldValue

Documentation: https://developers.activecampaign.com/reference//list-all-custom-fielddata-field-values

Column Type Relates to Notes
RemoteID string - -
DealRemoteID string Deal → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
DealCustomFieldMetumID long - -
DealID long Deal → ID -
CustomFieldID long DealCustomField → ID -
CreatedTimestamp string - -
UpdatedTimestamp string - -

Pipeline

Documentation: https://developers.activecampaign.com/reference/pipelines

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Title string - -
Allgroups boolean - -
Allusers boolean - -
Autoassign boolean - -
Cdate datetime - -
Udate datetime - -
Currency string - -

Stage

Documentation: https://developers.activecampaign.com/reference/deal-stages

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
PipelineID long Pipeline → ID
  • 16 Nov 2022 This field is called 'group' in the API - it refers to the parent PipelineID
CardRegion1 string - -
CardRegion2 string - -
CardRegion3 string - -
CardRegion4 string - -
CardRegion5 string - -
Cdate datetime - -
Udate datetime - -
Color string - -
DealOrder string - -
Order decimal - -
Title string - -
Width decimal - -

Campaign

Documentation: https://developers.activecampaign.com/reference/list-all-campaigns

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Cdate datetime - -
Mdate datetime - -
User int - -
Automation long Automation → ID -
Type string - -
Segmentid long - -
Bounceid long - -
Realcid long - -
Sendid long - -
Threadid long - -
Seriesid long - -
Formid long - -
Basetemplateid string - -
Basemessageid long - -
Addressid long - -
Source string - -
Sdate datetime - -
Ldate datetime - -
SendAmt int - -
TotalAmt int - -
Opens int - -
Uniqueopens int - -
Linkclicks int - -
Uniquelinkclicks int - -
Subscriberclicks int - -
Forwards int - -
Hardbounces int - -
Softbounces int - -
Unsubscribes int - -
Unsubreasons int - -
Updates int - -
Socialshares int - -
Replies int - -
Uniquereplies int - -
Status int - -
MailTransfer int - -
MailSend int - -
MailCleanup int - -
MailerLogFile int - -
Tracklinks string - -
Tracklinksanalytics int - -
Trackreads int - -
Trackreadsanalytics int - -
AnalyticsCampaignName string - -
Recurring string - -
Willrecur boolean - -
SplitType string - -
SplitContent int - -
SplitOffset int - -
SplitOffsetType string - -
SplitWinnerMessageid int - -
SplitWinnerAwaiting int - -
ResponderOffset int - -
ResponderType string - -
ResponderExisting int - -
ReminderField string - -
ReminderFormat string - -
ReminderType string - -
ReminderOffset int - -
ReminderOffsetType string - -
ReminderOffsetSign string - -
ActiverssInterval string - -
ActiverssUrl string - -
ActiverssItems int - -
Ip4 long - -
Laststep string - -
Managetext int - -
Schedule int - -
Scheduleddate datetime - -
Waitpreview int - -
Replysys int - -

Message

Documentation: https://developers.activecampaign.com/reference/list-all-messages

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
User long - -
Cdate datetime - -
Mdate datetime - -
EdInstanceid int - -
EdVersion int - -
Fromname string - -
Fromemail string - -
Reply2 string - -
Priority int - -
Charset string - -
Encoding string - -
Format string - -
Subject string - -
Text string - -
Html string - -
Htmlfetch string - -
Textfetch string - -
PreheaderText string - -
Hidden int - -
PreviewMime string - -
PreviewData string - -

ContactActivity

Documentation: https://developers.activecampaign.com/reference/list-contact-activities

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
User int - -
Tstamp datetime - -
ContactID long Contact → ID
  • 16 Nov 2022 Comes down as 'subscriberID' via the API
ReferenceType string - -
ReferenceID long -
  • 16 Nov 2022 The reference_id changes depending on the reference_type
DealActivityID long DealActivity → ID -
ReferenceAction string - -
JsonData string - -
Permission string - -
ReferenceModelName string - -

List

Documentation: https://developers.activecampaign.com/reference/lists

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
User int - -
Cdate datetime - -
Udate datetime - -
Stringid string - -
Userid int - -
PUseTracking boolean - -
PUseAnalyticsRead boolean - -
PUseAnalyticsLink boolean - -
PUseTwitter boolean - -
PUseFacebook boolean - -
PEmbedImage boolean - -
PUseCaptcha boolean - -
SendLastBroadcast boolean - -
AnalyticsDomains string - -
AnalyticsSource string - -
AnalyticsUa string - -
Carboncopy boolean - -
SubscriptionNotify boolean - -
UnsubscriptionNotify boolean - -
RequireName boolean - -
GetUnsubscribeReason boolean - -
ToName string - -
Optinoptout int - -
SenderName string - -
SenderAddr1 string - -
SenderAddr2 string - -
SenderCity string - -
SenderState string - -
SenderZip string - -
SenderCountry string - -
SenderPhone string - -
SenderUrl string - -
SenderReminder string - -
Fulladdress string - -
Optinmessageid int - -
Optoutconf int - -

Automation

Documentation: https://developers.activecampaign.com/reference/contactAutomations

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Cdate datetime - -
Mdate datetime - -
Userid long - -
Status int - -
Entered int - -
Exited int - -
Hidden boolean - -
EntitlementsViolation boolean - -

ContactGeoAddress

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Contact long Contact → ID -
Ip4 long - -
Country2 string - -
Country string - -
State string - -
City string - -
Area int - -
Lat decimal - -
Lon decimal - -
Tz string - -
Tstamp datetime - -

ContactGeoIp

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Contact long Contact → ID -
Campaignid int - -
Messageid int - -
Geoaddrid int - -
Tstamp datetime - -
GeoAddress long - -

ContactAutomation

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Automation long Automation → ID -
Contact long Contact → ID -
Seriesid int - -
Startid int - -
Status int - -
Batchid string - -
Adddate datetime - -
Remdate datetime - -
Timespan decimal - -
Lastblock int - -
Lastlogid int - -
Lastdate datetime - -
InAls int - -
CompletedElements int - -
TotalElements int - -
Completed boolean - -
CompleteValue decimal - -

DealCustomFieldValueOption

Column Type Relates to Notes
RemoteID string - -
DealCustomFieldValueRemoteID string DealCustomFieldValue → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DealCustomFieldValue long DealCustomFieldValue → ID -
Value string - -

DealActivity

Documentation: https://developers.activecampaign.com/reference/retrieve-a-deal

Column Type Relates to Notes
RemoteID string - -
DealRemoteID string Deal → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Deal long Deal → ID -
Stage long Stage → ID -
User long - -
Automation long Automation → ID -
ContactID long - -
DataID long -
  • 16 Nov 2022 The dataId relationship depends on the dataType
DataType string - -
DataAction string - -
DataOldval string - -
Cdate datetime - -
Sortdate datetime - -
IsAddtask boolean - -
Deleted boolean - -
Seriesid long - -

ContactCustomFieldValueOption

Column Type Relates to Notes
RemoteID string - -
ContactCustomFieldValueRemoteID string ContactCustomFieldValue → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactCustomFieldValue long ContactCustomFieldValue → ID -
Value string - -

Need more?

SyncHub lives and breathes APIs and data. Keep exploring using the links below.