ActiveCampaign Connector Objects

NameDescription
AccountContactsUsage information for the operation AccountContacts.rsd.
AccountCustomFieldDataCreate, modify, delete and query the available deal custom field data in ActiveCampaign.
AccountsView many or all contacts by including their ID's or various filters.
AddressesUsage information for the operation Addresses.rsd.
AutomationsUsage information for the operation Automations.rsd.
CampaignsQuery the campaigns information in ActiveCampaign.
ContactAutomationsView many or all contacts by including their ID's or various filters.
ContactCustomFieldDataCreate, modify, delete and query the available contact custom field data in ActiveCampaign.
ContactListsRetrieve ContactList for each contact Group or for the specific Contact group.
ContactsView many or all contacts by including their ID's or various filters.
ContactTagsRetrieve tags added for each contact or for the specific Contact Id
DealActivitiesRetrieve Deal Activities for each Deal or for the specific Deal Id.
DealCustomFieldDataCreate, modify, delete and query the available deal custom field data in ActiveCampaign.
DealGroupsLists all existing accounts.
DealsUsage information for the operation Deals.rsd.
DealStagesUsage information for the operation DealStages.rsd.
ListsUsage information for the operation Lists.rsd.
ScoresView many or all contacts by including their ID's or various filters.
TagsView many or all tags by including their ID's or various filters.
TasksLists all existing accounts.
TrackingLogsRetrieve trackingLogs for the specific contact or all contacts
UsersUsage information for the operation Users.rsd.
NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id of the account-contact association.
AccountIdStringFalseAccounts.IdNoThe account Id.
ContactIdStringFalseContacts.IdNoThe contact Id.
CreatedTimestampDatetimeTrueNoDatetime value which indicates when the assosiaction was created.
JobTitleStringFalseNoJob Title of the contact at the account.
AccountLinkStringTrueNoAccount link.
ContactLinkStringTrueNoContact link.
UpdatedTimestampDatetimeTrueNoDatetime value which indicates when the assosiaction was last updated.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id of the account custom field data.
AccountCustomFieldMetumIdIntegerTrueNoThe custom field metum Id.
AccountIdIntegerFalseNoThe ID of the account the field value relates to.
CreatedTimestampDatetimeTrueNoDatetime value that indicates when the custom field value was set.
CustomFieldIdIntegerFalseNoThe ID of the custom field metum the field value relates to.
CustomFieldNameStringTrueNoThe name of the custom field metum the field value relates to.
FieldValueStringFalseNoValues for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5).
AccountLinkStringTrueNoAccount link.
AccountCustomFieldMetumLinkStringTrueNoAccountCustomFieldMetum link.
UpdatedTimestampDatetimeTrueNoDatetime value which indicates when the custom field data was last updated.
FieldCurrencyStringFalseNoValue of the custom field currency type for a specific contact. This field is required when inserting currency custom fields.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id column of the Accounts table.
AccountUrlStringFalseNoAccount's website.
ContactCountIntegerTrueNoThe ContactCount column of the Accounts table.
CreatedTimestampDatetimeTrueNoThe CreatedTimestamp column of the Accounts table.
DealCountIntegerTrueNoThe DealCount column of the Accounts table.
AccountContactsLinkStringTrueNoThe AccountContactsLink column of the Accounts table.
AccountCustomFieldDataLinkStringTrueNoThe AccountCustomFieldDataLink column of the Accounts table.
ContactEmailsLinkStringTrueNoThe ContactEmailsLink column of the Accounts table.
EmailActivitiesLinkStringTrueNoThe EmailActivitiesLink column of the Accounts table.
NotesLinkStringTrueNoThe NotesLink column of the Accounts table.
NameStringFalseNoAccount's name.
UpdatedTimestampDatetimeTrueNoThe UpdatedTimestamp column of the Accounts table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringTrueNoThe Id column of the Addresses table.
Address1StringTrueNoThe Address1 column of the Addresses table.
Address2StringTrueNoThe Address2 column of the Addresses table.
AllgroupStringTrueNoThe Allgroup column of the Addresses table.
CityStringTrueNoThe City column of the Addresses table.
CompanyNameStringTrueNoThe CompanyName column of the Addresses table.
CountryStringTrueNoThe Country column of the Addresses table.
DistrictStringTrueNoThe District column of the Addresses table.
isDefaultStringTrueNoThe isDefault column of the Addresses table.
AddressGroupLinkStringTrueNoThe AddressGroupLink column of the Addresses table.
AddressListLinkStringTrueNoThe AddressListLink column of the Addresses table.
FormsLinkStringTrueNoThe FormsLink column of the Addresses table.
StateStringTrueNoThe State column of the Addresses table.
ZipStringTrueNoThe Zip column of the Addresses table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringTrueNoThe Id column of the Automations table.
CdateDatetimeTrueNoThe Cdate column of the Automations table.
DefaultScreenshotStringTrueNoThe DefaultScreenshot column of the Automations table.
EnteredStringTrueNoThe Entered column of the Automations table.
ExitedStringTrueNoThe Exited column of the Automations table.
HiddenStringTrueNoThe Hidden column of the Automations table.
BlocksLinkStringTrueNoThe BlocksLink column of the Automations table.
CampaignsLinkStringTrueNoThe CampaignsLink column of the Automations table.
ContactAutomationsLinkStringTrueNoThe ContactAutomationsLink column of the Automations table.
ContactGoalsLinkStringTrueNoThe ContactGoalsLink column of the Automations table.
GoalsLinkStringTrueNoThe GoalsLink column of the Automations table.
SiteMessagesLinkStringTrueNoThe SiteMessagesLink column of the Automations table.
SmsLinkStringTrueNoThe SmsLink column of the Automations table.
MdateDatetimeTrueNoThe Mdate column of the Automations table.
NameStringTrueNoThe Name column of the Automations table.
ScreenshotStringTrueNoThe Screenshot column of the Automations table.
StatusStringTrueNoThe Status column of the Automations table.
UserIdStringTrueNoThe UserId column of the Automations table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id column of the Campaigns table.
ActiveRssIntervalStringTrueNoThe ActiveRssInterval column of the Campaigns table.
ActiveRssItemsStringTrueNoThe ActiveRssItems column of the Campaigns table.
ActiveRssUrlStringTrueNoThe ActiveRssUrl column of the Campaigns table.
AddressIdStringTrueNoThe AddressId column of the Campaigns table.
AnalyticsCampaignNameStringTrueNoThe AnalyticsCampaignName column of the Campaigns table.
AutomationStringTrueNoThe Automation column of the Campaigns table.
BaseMessageIdStringTrueNoThe BaseMessageId column of the Campaigns table.
BaseTemplateIdStringTrueNoThe BaseTemplateId column of the Campaigns table.
BounceIdStringTrueNoThe BounceId column of the Campaigns table.
CanSkipApprovalStringTrueNoThe can_skip_approval column of the Campaigns table.
CdateDatetimeTrueNoThe Cdate column of the Campaigns table.
CreatedByStringTrueNoThe Created By column of the Campaigns table.
CreatedTimestampDatetimeTrueNoThe Created Timestamp column of the Campaigns table.
DeleteStampStringTrueNoThe DeleteStamp column of the Campaigns table.
EmbedImagesStringTrueNoThe EmbedImages column of the Campaigns table.
FacebookStringTrueNoThe Facebook column of the Campaigns table.
FormIdStringTrueNoThe FormId column of the Campaigns table.
ForwardsStringTrueNoThe Forwards column of the Campaigns table.
HardBouncesStringTrueNoThe HardBounces column of the Campaigns table.
HasPredictiveContentBitTrueNoThe HasPredictiveContent column of the Campaigns table.
HtmlUnsubStringTrueNoThe HtmlUnsub column of the Campaigns table.
HtmlUnsubdataStringTrueNoThe HtmlUnsubdata column of the Campaigns table.
IpStringTrueNoThe Ip column of the Campaigns table.
Ip4StringTrueNoThe Ip4 column of the Campaigns table.
LastStepStringTrueNoThe LastStep column of the Campaigns table.
LdateStringTrueNoThe Ldate column of the Campaigns table.
LinkClicksStringTrueNoThe LinkClicks column of the Campaigns table.
AutomationLinkStringTrueNoThe AutomationLink column of the Campaigns table.
CampaignAggregateRevenuesLinkStringTrueNoThe AggregateRevenues column of the Campaigns table.
CampaignListsLinkStringTrueNoThe CampaignListsLink column of the Campaigns table.
CampaignMessageLinkStringTrueNoThe CampaignMessageLink column of the Campaigns table.
CampaignMessagesLinkStringTrueNoThe CampaignMessagesLink column of the Campaigns table.
LinksLinkStringTrueNoThe LinksLink column of the Campaigns table.
LinksSegmentStringTrueNoThe Segment column of the Campaigns table.
UserLinkStringTrueNoThe UserLink column of the Campaigns table.
MailCleanupStringTrueNoThe MailCleanup column of the Campaigns table.
MailSendStringTrueNoThe MailSend column of the Campaigns table.
MailTransferStringTrueNoThe MailTransfer column of the Campaigns table.
MailerLogFileStringTrueNoThe MailerLogFile column of the Campaigns table.
ManageTextStringTrueNoThe ManageText column of the Campaigns table.
MdateDatetimeTrueNoThe Mdate column of the Campaigns table.
NameStringTrueNoThe Name column of the Campaigns table.
OpensStringTrueNoThe Opens column of the Campaigns table.
PublicStringTrueNoThe Public column of the Campaigns table.
RealCidStringTrueNoThe RealCid column of the Campaigns table.
RecurringStringTrueNoThe Recurring column of the Campaigns table.
ReminderFieldStringTrueNoThe ReminderField column of the Campaigns table.
ReminderFormatStringTrueNoThe ReminderFormat column of the Campaigns table.
ReminderLastCronRunStringTrueNoThe ReminderLastCronRun column of the Campaigns table.
ReminderOffsetStringTrueNoThe ReminderOffset column of the Campaigns table.
ReminderOffsetSignStringTrueNoThe ReminderOffsetSign column of the Campaigns table.
ReminderOffsetTypeStringTrueNoThe ReminderOffsetType column of the Campaigns table.
ReminderTypeStringTrueNoThe ReminderType column of the Campaigns table.
RepliesStringTrueNoThe Replies column of the Campaigns table.
ReplySysStringTrueNoThe ReplySys column of the Campaigns table.
ResponderExistingStringTrueNoThe ResponderExisting column of the Campaigns table.
ResponderOffsetStringTrueNoThe ResponderOffset column of the Campaigns table.
ResponderTypeStringTrueNoThe ResponderType column of the Campaigns table.
ScheduleStringTrueNoThe Schedule column of the Campaigns table.
ScheduledDateStringTrueNoThe ScheduledDate column of the Campaigns table.
ScreenshotStringTrueNoThe Screenshot column of the Campaigns table.
SdateStringTrueNoThe Sdate column of the Campaigns table.
SegmentIdStringTrueNoThe SegmentId column of the Campaigns table.
SegmentNameStringTrueNoThe SegmentName column of the Campaigns table.
SendAmtStringTrueNoThe SendAmt column of the Campaigns table.
SendIdStringTrueNoThe SendId column of the Campaigns table.
SeriesIdStringTrueNoThe SeriesId column of the Campaigns table.
Series Send Lock TimeStringTrueNoThe SeriesSendLockTime column of the Campaigns table.
SocialSharesStringTrueNoThe SocialShares column of the Campaigns table.
SoftBouncesStringTrueNoThe SoftBounces column of the Campaigns table.
SourceStringTrueNoThe Source column of the Campaigns table.
SplitContentStringTrueNoThe SplitContent column of the Campaigns table.
SplitOffsetStringTrueNoThe SplitOffset column of the Campaigns table.
SplitOffsetTypeStringTrueNoThe SplitOffsetType column of the Campaigns table.
SplitTypeStringTrueNoThe SplitType column of the Campaigns table.
SplitWinnerAwaitingStringTrueNoThe SplitWinnerAwaiting column of the Campaigns table.
SplitWinnerMessageIdStringTrueNoThe SplitWinnerMessageId column of the Campaigns table.
StatusStringTrueNoThe Status column of the Campaigns table.
SubscriberClicksStringTrueNoThe SubscriberClicks column of the Campaigns table.
SurveyStringTrueNoThe Survey column of the Campaigns table.
TextUnsubStringTrueNoThe TextUnsub column of the Campaigns table.
TextUnsubDataStringTrueNoThe TextUnsubData column of the Campaigns table.
ThreadIdStringTrueNoThe ThreadId column of the Campaigns table.
TotalAmtStringTrueNoThe TotalAmt column of the Campaigns table.
TrackLinksStringTrueNoThe TrackLinks column of the Campaigns table.
TrackLinksAnalyticsStringTrueNoThe TrackLinksAnalytics column of the Campaigns table.
TrackReadsStringTrueNoThe TrackReads column of the Campaigns table.
TrackReadsAnalyticsStringTrueNoThe TrackReadsAnalytics column of the Campaigns table.
TweetStringTrueNoThe Tweet column of the Campaigns table.
TypeStringTrueNoThe Type column of the Campaigns table.
UniqueForwardsStringTrueNoThe UniqueForwards column of the Campaigns table.
UniqueLinkClicksStringTrueNoThe UniqueLinkClicks column of the Campaigns table.
UniqueOpensStringTrueNoThe UniqueOpens column of the Campaigns table.
UniqueRepliesStringTrueNoThe UniqueReplies column of the Campaigns table.
UnsubReasonsStringTrueNoThe UnsubReasons column of the Campaigns table.
UnsubscribesStringTrueNoThe Unsubscribes column of the Campaigns table.
Updated ByStringTrueNoThe UpdatedBy column of the Campaigns table.
Updated TimestampStringTrueNoThe UpdatedTimestamp column of the Campaigns table.
UpdatesStringTrueNoThe Updates column of the Campaigns table.
UserStringTrueNoThe User column of the Campaigns table.
UserIdStringTrueNoThe UserId column of the Campaigns table.
WaitPreviewStringTrueNoThe WaitPreview column of the Campaigns table.
WillRecurStringTrueNoThe WillRecur column of the Campaigns table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringTrueNoThe Id column of the ContactAutomations table.
AdddateDatetimeTrueNoThe Adddate column of the ContactAutomations table.
AutomationStringTrueNoThe Automation column of the ContactAutomations table.
BatchidUnknownTrueNoThe Batchid column of the ContactAutomations table.
CompleteValueIntegerTrueNoThe CompleteValue column of the ContactAutomations table.
CompletedIntegerTrueNoThe Completed column of the ContactAutomations table.
CompletedElementsStringTrueNoThe CompletedElements column of the ContactAutomations table.
ContactIdStringTrueContacts.IdNoThe ContactId column of the ContactAutomations table.
LastblockStringTrueNoThe Lastblock column of the ContactAutomations table.
LastdateDatetimeTrueNoThe Lastdate column of the ContactAutomations table.
LastLogIdStringTrueNoThe LastLogId column of the ContactAutomations table.
AutomationLinkStringTrueNoThe AutomationLink column of the ContactAutomations table.
ContactLinkStringTrueNoThe ContactLink column of the ContactAutomations table.
ContactGoalsLinkStringTrueNoThe ContactGoalsLink column of the ContactAutomations table.
RemdateDatetimeTrueNoThe Remdate column of the ContactAutomations table.
SeriesIdStringTrueNoThe SeriesId column of the ContactAutomations table.
StartIdStringTrueNoThe StartId column of the ContactAutomations table.
StatusStringTrueNoThe Status column of the ContactAutomations table.
TimeSpanStringTrueNoThe TimeSpan column of the ContactAutomations table.
TotalElementsStringTrueNoThe TotalElements column of the ContactAutomations table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id column of the ContactCustomFieldData table.
CDateDatetimeFalseNoThe CDate column of the ContactCustomFieldData table.
ContactIdStringFalseNoThe ContactId column of the ContactCustomFieldData table.
CustomFieldNameStringTrueNoThe name of the custom field metum the field value relates to.
FieldIdStringFalseNoID of the field the value belongs to.
FieldLinkStringFalseNoThe FieldLink column of the ContactCustomFieldData table.
OwnerLinkStringFalseNoThe OwnerLink column of the ContactCustomFieldData table.
OwnerStringFalseNoThe Owner column of the ContactCustomFieldData table.
UdateDatetimeFalseNoThe Udate column of the ContactCustomFieldData table.
FieldValueStringFalseNoValue of the custom field for a specific contact.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id column of the ContactLists table.
ContactIdStringTrueContacts.IdNoThe ContactId column of the ContactLists table.
AutomationIdStringTrueAutomations.IdNoThe AutomationId column of the ContactLists table.
AutosyncLogStringTrueNoThe AutosyncLog column of the ContactLists table.
CampaignStringTrueNoThe Campaign column of the ContactLists table.
CreatedByStringTrueNoThe CreatedBy column of the ContactLists table.
CreatedTimestampDatetimeTrueNoThe CreatedTimestamp column of the ContactLists table.
FirstNameStringTrueNoThe FirstName column of the ContactLists table.
FormStringTrueNoThe Form column of the ContactLists table.
Ip4SubStringTrueNoThe Ip4Sub column of the ContactLists table.
Ip4UnsubStringTrueNoThe Ip4Unsub column of the ContactLists table.
Ip4LastStringTrueNoThe Ip4Last column of the ContactLists table.
LastNameStringTrueNoThe LastName column of the ContactLists table.
AutomationLinkStringTrueNoThe AutomationLink column of the ContactLists table.
AutosyncLogLinkStringTrueNoThe AutosyncLogLink column of the ContactLists table.
CampaignLinkStringTrueNoThe CampaignLink column of the ContactLists table.
ContactLinkStringTrueNoThe ContactLink column of the ContactLists table.
FormLinkStringTrueNoThe FormLink column of the ContactLists table.
ListLinkStringTrueNoThe ListLink column of the ContactLists table.
MessageLinkStringTrueNoThe MessageLink column of the ContactLists table.
UnsubscribeAutomationLinkStringTrueNoThe UnsubscribeAutomationLink column of the ContactLists table.
ListIdStringTrueLists.IdNoThe ListId column of the ContactLists table.
MessageStringTrueNoThe Message column of the ContactLists table.
ResponderStringTrueNoThe Responder column of the ContactLists table.
SdateDatetimeTrueNoThe Sdate column of the ContactLists table.
SeriesIdStringTrueNoThe SeriesId column of the ContactLists table.
StatusStringTrueNoThe Status column of the ContactLists table.
SourceIdStringTrueNoThe SourceId column of the ContactLists table.
SyncStringTrueNoThe Sync column of the ContactLists table.
UnsubreasonStringTrueNoThe Unsubreason column of the ContactLists table.
UnsubscribeAutomationStringTrueNoThe UnsubscribeAutomation column of the ContactLists table.
UpdatedByStringTrueNoThe UpdatedBy column of the ContactLists table.
UpdatedTimestampDatetimeTrueNoThe UpdatedTimestamp column of the ContactLists table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id column of the Contacts table.
AdateDatetimeTrueNoThe Adate column of the Contacts table.
AnonymizedStringTrueNoThe Anonymized column of the Contacts table.
BouncedDateStringTrueNoThe BouncedDate column of the Contacts table.
BouncedHardStringTrueNoThe BouncedHard column of the Contacts table.
BouncedSoftStringTrueNoThe BouncedSoft column of the Contacts table.
CdateDatetimeTrueNoThe Cdate column of the Contacts table.
CreatedByStringTrueNoThe CreatedBy column of the Contacts table.
CreatedTimestampDatetimeTrueNoThe CreatedTimestamp column of the Contacts table.
CreatedUtcTimestampDatetimeTrueNoThe CreatedUtcTimestamp column of the Contacts table.
DeletedStringTrueNoThe Deleted column of the Contacts table.
DeletedAtStringTrueNoThe DeletedAt column of the Contacts table.
EdateDatetimeTrueNoThe Edate column of the Contacts table.
EmailStringFalseNoThe Email column of the Contacts table.
EmailDomainStringTrueNoThe EmailDomain column of the Contacts table.
EmailEmptyBooleanTrueNoThe EmailEmpty column of the Contacts table.
EmailLocalStringTrueNoThe EmailLocal column of the Contacts table.
FirstNameStringFalseNoThe FirstName column of the Contacts table.
GravatarStringTrueNoThe Gravatar column of the Contacts table.
HashStringTrueNoThe Hash column of the Contacts table.
IpStringTrueNoThe Ip column of the Contacts table.
LastNameStringFalseNoThe LastName column of the Contacts table.
AccountContactsLinkStringTrueNoThe AccountContactsLink column of the Contacts table.
AutomationEntryCountsLinkStringTrueNoThe AutomationEntryCountsLink column of the Contacts table.
BounceLogsLinkStringTrueNoThe BounceLogsLink column of the Contacts table.
ContactAutomationsLinkStringTrueNoThe ContactAutomationsLink column of the Contacts table.
ContactDataLinkStringTrueNoThe ContactDataLink column of the Contacts table.
ContactDealsLinkStringTrueNoThe ContactDealsLink column of the Contacts table.
ContactGoalsLinkStringTrueNoThe ContactGoalsLink column of the Contacts table.
ContactListsLinkStringTrueNoThe ContactListsLink column of the Contacts table.
ContactLogsLinkStringTrueNoThe ContactLogsLink column of the Contacts table.
ContactTagsLinkStringTrueNoThe ContactTagsLink column of the Contacts table.
DealsLinkStringTrueNoThe DealsLink column of the Contacts table.
FieldValuesLinkStringTrueNoThe FieldValuesLink column of the Contacts table.
GeoIpsLinkStringTrueNoThe GeoIpsLink column of the Contacts table.
NotesLinkStringTrueNoThe NotesLink column of the Contacts table.
OrganizationLinkStringTrueNoThe OrganizationLink column of the Contacts table.
PlusAppendLinkStringTrueNoThe PlusAppendLink column of the Contacts table.
ScoreValuesLinkStringTrueNoThe ScoreValuesLink column of the Contacts table.
TrackingLogsLinkStringTrueNoThe TrackingLogsLink column of the Contacts table.
OrganizationStringTrueNoThe Organization column of the Contacts table.
OrgnameStringTrueNoThe Orgname column of the Contacts table.
PhoneStringFalseNoThe Phone column of the Contacts table.
RatingTStampStringTrueNoThe RatingTStamp column of the Contacts table.
SegmentioIdStringTrueNoThe SegmentioId column of the Contacts table.
SentcntStringTrueNoThe Sentcnt column of the Contacts table.
SocialdataLastcheckStringTrueNoThe SocialdataLastcheck column of the Contacts table.
UaStringTrueNoThe Ua column of the Contacts table.
UdateDatetimeTrueNoThe Udate column of the Contacts table.
UpdatedTimestampStringTrueNoThe UpdatedTimestamp column of the Contacts table.
Updated_byStringTrueNoThe Updated_by column of the Contacts table.
SubscribeToStringFalseNoComma-separated list of list Ids to subscribe a contact to.
UnsubscribeFromStringFalseNoComma-separated list of list Ids to unsubscribe a contact from.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id column of the ContactTags table.
ContactIdStringTrueContacts.IdNoThe ContactId column of the ContactTags table.
CdateDatetimeTrueNoThe Cdate column of the ContactTags table.
CreatedByStringTrueNoThe CreatedBy column of the ContactTags table.
CreatedTimestampDatetimeTrueNoThe CreatedTimestamp column of the ContactTags table.
ContactLinkStringTrueNoThe ContactLink column of the ContactTags table.
TagLinkStringTrueNoThe TagLink column of the ContactTags table.
TagStringTrueNoThe Tag column of the ContactTags table.
UpdatedByStringTrueNoThe UpdatedBy column of the ContactTags table.
UpdatedTimestampDatetimeTrueNoThe UpdatedTimestamp column of the ContactTags table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id of the activity.
DealIdStringTrueDeals.IdNoThe Id of the Deal to which the activity belongs to.
StageIdStringTrueDealStages.IdNoThe Id of the Stage to which the parent Deal of the activity belongs to.
UserIdStringTrueUsers.IdNoThe Id of the User which triggered the activity.
DataIdStringTrueNoThe Id for the related object (e.g. a Task or Note or similar), if relevant.
DataTypeStringTrueNoThe type of the activity. Examples include 'userid' or 'subscriberid' or 'task' or 'note' or empty quotes ('') for the deal's initial creation.
DataActionStringTrueNoThe action taken by this activity. Examples include 'add' or 'complete' or the new value ('100') if the value is changing.
DataOldValStringTrueNoThe previous value, if the value has changed (see DataAction); otherwise, empty quotes ('')
CreatedDateDatetimeTrueNoThe creation date of the activity.
SortDateDatetimeTrueNo
IsAddTaskBooleanTrueNoIndicates whether the activity was adding a task to the deal.
DeletedBooleanTrueNoIndicates whethere the activity was deleted or not.
SeriesIdStringTrueNo
DealLinkStringTrueNoThe API endpoint to the Deal related to this activity.
StageLinkStringTrueNoThe API endpoint to the Stage related to this activity.
UserLinkStringTrueNoThe API endpoint to the User related to this activity.
AutomationLinkStringTrueNoThe API endpoint to the Automation related to this activity.
ActivityLinkStringTrueNoThe API endpoint to the Activity.
DealStringTrueNoThe related to this Activity.
StageStringTrueNoThe Stage column of the DealActivities table.
UserStringTrueNoThe User column of the DealActivities table.
AutomationStringTrueNoThe Automation which triggered this activity.
ExcludeStringFalseYesInclude this param to exclude 'email', 'connection_email', and 'LinkData' activity types.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id column of the DealCustomFieldData table.
CreatedTimestampDatetimeFalseNoThe CreatedTimestamp column of the DealCustomFieldData table.
CustomFieldNameStringTrueNoThe name of the custom field metum the field value relates to.
CustomFieldIdIntegerFalseNoThe CustomFieldId column of the DealCustomFieldData table.
DealCustomFieldMetumIdIntegerFalseNoThe DealCustomFieldMetumId column of the DealCustomFieldData table.
DealIdIntegerFalseNoThe DealId column of the DealCustomFieldData table.
FieldValueStringFalseNoThe FieldValue column of the DealCustomFieldData table.
DealLinkStringFalseNoThe DealLink column of the DealCustomFieldData table.
DealCustomFieldMetumLinkStringFalseNoThe DealCustomFieldMetumLink column of the DealCustomFieldData table.
UpdatedTimestampDatetimeFalseNoThe UpdatedTimestamp column of the DealCustomFieldData.
FieldCurrencyStringFalseNoValue of the custom field currency type for a specific deal. This field is required when inserting currency custom fields.
FieldTypeStringFalseNoValue of the custom field currency type for a specific deal. This field is required when inserting currency custom fields.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe pipeline Id.
AllGroupsStringFalseNoThe AllGroups column of the DealGroups table. Indicates whether all user groups have permission to manage this pipeline. Can be either 1 or 0. If 1, all user groups can manage this pipeline. If 0, only user groups in dealGroup.groups parameter can manage this pipeline.
AllUsersStringFalseNoThe AllUsers column of the DealGroups table. Indicates whether new deals get auto-assigned to all users. Can be either 1 or 0. If 1, new deals are auto-assigned to all users unless auto-assign is disabled. If 0, new deals are auto-assigned to only the users in dealGroup.users parameter.
AutoAssignStringFalseNoThe AutoAssign column of the DealGroups table. Deal auto-assign option. Can be one of 0, 1, and 2. If 0, auto-assign is disabled. If 1, Round Robin method is used to auto-assign new deals. If 2, deals are distributed based on deal values.
CdateDatetimeTrueNoThe Cdate column of the DealGroups table.
CurrencyStringFalseNoThe Currency column of the DealGroups table.
DealGroupGroupsLinkStringTrueNoThe DealGroupGroupsLink column of the DealGroups table.
DealGroupUsersLinkStringTrueNoThe DealGroupUsersLink column of the DealGroups table.
StagesLinkStringTrueNoThe StagesLink column of the DealGroups table.
StagesStringTrueNoThe Stages column of the DealGroups table.
TitleStringFalseNoPipeline's title.
UdateDatetimeTrueNoThe Udate column of the DealGroups table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id column of the Deals table.
AccountIdStringFalseNoThe AccountId column of the Deals table.
ActivityCountStringTrueNoThe ActivityCount column of the Deals table.
CdateDatetimeTrueNoThe Cdate column of the Deals table.
ContactIdStringFalseNoDeal's primary contact's Id.
CurrencyStringFalseNoDeal's currency in 3-digit ISO format, lowercased.
CustomerAccountStringTrueNoThe CustomerAccount column of the Deals table.
DescriptionStringFalseNoThe Description column of the Deals table.
EdateStringTrueNoThe Edate column of the Deals table.
GroupStringFalseNoDeal's pipeline Id. Required if deal.stage is not provided. If deal.group is not provided, the stage's pipeline will be assigned to the deal automatically.
HashStringTrueNoThe Hash column of the Deals table.
IsDisabledStringTrueNoThe IsDisabled column of the Deals table.
AccountLinkStringTrueNoThe AccountLink column of the Deals table.
ContactLinkStringTrueNoThe ContactLink column of the Deals table.
ContactDealsLinkStringTrueNoThe ContactDealsLink column of the Deals table.
CustomerAccountLinkStringTrueNoThe CustomerAccountLink column of the Deals table.
DealActivitiesLinkStringTrueNoThe DealActivitiesLink column of the Deals table.
DealCustomFieldDataLinkStringTrueNoThe DealCustomFieldDataLink column of the Deals table.
GroupLinkStringTrueNoThe GroupLink column of the Deals table.
NextTaskLinkStringTrueNoThe NextTaskLink column of the Deals table.
NotesLinkStringTrueNoThe NotesLink column of the Deals table.
OrganizationLinkStringTrueNoThe OrganizationLink column of the Deals table.
OwnerLinkStringTrueNoThe OwnerLink column of the Deals table.
ScoreValuesLinkStringTrueNoThe ScoreValuesLink column of the Deals table.
StageLinkStringTrueNoThe StageLink column of the Deals table.
TasksLinkStringTrueNoThe TasksLink column of the Deals table.
MdateDatetimeTrueNoThe Mdate column of the Deals table.
NextTaskStringTrueNoThe NextTask column of the Deals table.
NextDateDatetimeTrueNoThe NextDate column of the Deals table.
NextDealIdStringTrueNoThe NextDealId column of the Deals table.
NextTaskIdStringTrueNoThe NextTaskId column of the Deals table.
OrganizationStringTrueNoThe Organization column of the Deals table.
OwnerStringFalseNoDeal's owner Id. Required if pipeline's auto-assign option is disabled.
PercentStringFalseNoThe Percent column of the Deals table.
StageStringFalseNoDeal's stage Id. Required if deal.group is not provided. If deal.stage is not provided, the deal will be assigned with the first stage in the pipeline provided in deal.group.
StatusStringFalseNoThe Status column of the Deals table.
TitleStringFalseNoThe Title column of the Deals table.
ValueStringFalseNoDeal's value in cents.
WinProbabilityIntegerTrueNoThe WinProbability column of the Deals table.
WinProbabilityMdateDatetimeTrueNoThe WinProbabilityMdate column of the Deals table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id column of the DealStages table.
CardRegion1StringFalseNoThe CardRegion1 column of the DealStages table. Indicates what to show in upper-left corner of Deal Cards.
CardRegion2StringFalseNoThe CardRegion2 column of the DealStages table. Indicates what to show in upper-right corner of Deal Cards.
CardRegion3StringFalseNoThe CardRegion3 column of the DealStages table. Indicates whether to show the avatar in Deal Cards. Can be one of show-avatar and hide-avatar. If set to show-avatar, deal cards will show the avatars. If set to hide-avatar, deal cards will hide the avatars.
CardRegion4StringFalseNoThe CardRegion4 column of the DealStages table. Indicates what to show next to the avatar in Deal Cards.
CardRegion5StringFalseNoThe CardRegion5 column of the DealStages table. Indicates what to show in lower-right corner of Deal Cards.
CdateDatetimeTrueNoThe Cdate column of the DealStages table.
ColorStringFalseNoDeal Stage's color. 6-character HEX color code without the hashtag. e.g. 434343 to assign the hex color value #434343.
DealOrderStringFalseNoOption and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either.
GroupIdStringFalseNoThe GroupId column of the DealStages table.
GroupLinkStringTrueNoThe GroupLink column of the DealStages table.
OrderIdStringFalseNoThe OrderId column of the DealStages table.
TitleStringFalseNoThe Title column of the DealStages table.
UdateDatetimeTrueNoThe Udate column of the DealStages table.
WidthStringFalseNoDeal stage's width in pixels, without px unit.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id column of the Lists table.
AnalyticsDomainsStringTrueNoThe AnalyticsDomains column of the Lists table.
AnalyticsSourceStringTrueNoThe AnalyticsSource column of the Lists table.
AnalyticsUaStringTrueNoThe AnalyticsUa column of the Lists table.
CarbonCopyStringTrueNoThe CarbonCopy column of the Lists table.
CdateDatetimeTrueNoThe Cdate column of the Lists table.
UdateDatetimeTrueNoThe Udate column of the Lists table.
DeleteStampStringTrueNoThe DeleteStamp column of the Lists table.
FacebookSessionStringTrueNoThe FacebookSession column of the Lists table.
FullAddressStringTrueNoThe FullAddress column of the Lists table.
UnsubscribeReasonStringTrueNoThe UnsubscribeReason column of the Lists table.
AddressListsLinkStringTrueNoThe AddressListsLink column of the Lists table.
ContactGoalListsLinkStringTrueNoThe ContactGoalListsLink column of the Lists table.
UserLinkStringTrueNoThe UserLink column of the Lists table.
NameStringTrueNoThe Name column of the Lists table.
OptinMessageIdStringTrueNoThe OptinMessageId column of the Lists table.
OptinOptoutStringTrueNoThe OptinOptout column of the Lists table.
OptoutConfStringTrueNoThe OptoutConf column of the Lists table.
EmbedImageStringTrueNoThe EmbedImage column of the Lists table.
UseAnalyticsLinkStringTrueNoThe UseAnalyticsLink column of the Lists table.
UseAnalyticsReadStringTrueNoThe UseAnalyticsRead column of the Lists table.
UseCaptchaStringTrueNoThe UseCaptcha column of the Lists table.
UseFacebookStringTrueNoThe UseFacebook column of the Lists table.
UseTrackingStringTrueNoThe UseTracking column of the Lists table.
UseTwitterStringTrueNoThe UseTwitter column of the Lists table.
PrivateStringTrueNoThe Private column of the Lists table.
RequireNameStringTrueNoThe RequireName column of the Lists table.
SendLastBroadcastStringTrueNoThe SendLastBroadcast column of the Lists table.
SenderAddr1StringTrueNoThe SenderAddr1 column of the Lists table.
SenderAddr2StringTrueNoThe SenderAddr2 column of the Lists table.
SenderCityStringTrueNoThe SenderCity column of the Lists table.
SenderCountryStringTrueNoThe SenderCountry column of the Lists table.
SenderNameStringTrueNoThe SenderName column of the Lists table.
SenderPhoneStringTrueNoThe SenderPhone column of the Lists table.
SenderReminderStringTrueNoThe SenderReminder column of the Lists table.
SenderStateStringTrueNoThe SenderState column of the Lists table.
SenderUrlStringTrueNoThe SenderUrl column of the Lists table.
SenderZipStringTrueNoThe SenderZip column of the Lists table.
StringIdStringTrueNoThe StringId column of the Lists table.
SubscriptionNotifyStringTrueNoThe SubscriptionNotify column of the Lists table.
ToNameStringTrueNoThe ToName column of the Lists table.
TwitterTokenStringTrueNoThe TwitterToken column of the Lists table.
TwitterTokenSecretStringTrueNoThe TwitterTokenSecret column of the Lists table.
UnsubscriptionNotifyStringTrueNoThe UnsubscriptionNotify column of the Lists table.
ListsUserStringTrueNoThe ListsUser column of the Lists table.
ListsUseridStringTrueNoThe ListsUserid column of the Lists table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringTrueNoThe Id column of the Scores table.
CdateDatetimeTrueNoThe Cdate column of the Scores table.
DescriptStringTrueNoThe Descript column of the Scores table.
MdateDatetimeTrueNoThe Mdate column of the Scores table.
NameStringTrueNoThe Name column of the Scores table.
RelTypeStringTrueNoThe RelType column of the Scores table.
StatusStringTrueNoThe Status column of the Scores table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id column of the Tags table.
TagStringTrueNoThe Tag column of the Tags table.
TagTypeStringTrueNoThe TagType column of the Tags table.
DescriptionStringTrueNoThe Description column of the Tags table.
CdateDatetimeTrueNoThe Cdate column of the Tags table.
ContactGoalTagsLinkStringTrueNoThe ContactGoalTagsLink column of the Tags table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id column of the Tasks table.
AssigneeStringFalseNoThe Assignee column of the Tasks table.
AutomationStringTrueNoThe Automation column of the Tasks table.
CdateDatetimeTrueNoThe Cdate column of the Tasks table.
DealTaskTypeStringFalseNoThe type of the task based on the available Task Types in the account.
DoneAutomationStringFalseNoThe DoneAutomation column of the Tasks table.
DueDateDatetimeFalseNoDue date of the task.
EdateDatetimeTrueNoThe Edate column of the Tasks table.
ActivitiesLinkStringTrueNoThe ActivitiesLink column of the Tasks table.
AssigneeLinkStringTrueNoThe AssigneeLink column of the Tasks table.
AutomationLinkStringTrueNoThe AutomationLink column of the Tasks table.
DealTasktypeLinkStringTrueNoThe DealTasktypeLink column of the Tasks table.
DoneAutomationLinkStringTrueNoThe DoneAutomationLink column of the Tasks table.
NotesLinkStringTrueNoThe NotesLink column of the Tasks table.
OwnerLinkStringTrueNoThe OwnerLink column of the Tasks table.
TaskNotificationsLinkStringTrueNoThe TaskNotificationsLink column of the Tasks table.
UserLinkStringTrueNoThe UserLink column of the Tasks table.
NoteStringFalseNoThe content describing the task.
OutcomeIdIntegerFalseNoThe OutcomeId column of the Tasks table.
OutcomeInfoStringFalseNoThe OutcomeInfo column of the Tasks table.
OwnerIdStringTrueNoThe OwnerId column of the Tasks table.
OwnerTypeStringFalseNoThe name of the relating object. Valid values are contact or deal.
RelidStringFalseNoThe Id of the relational object for this task.
ReltypeStringTrueNoThe Reltype column of the Tasks table.
StatusIntegerFalseNoThe Status column of the Tasks table. 1 is complete and 0 is incomplete..
TitleStringFalseNoThe Title column of the Tasks table.
UdateDatetimeTrueNoThe Udate column of the Tasks table.
UserStringTrueNoThe User column of the Tasks table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id column of the TrackingLogs table.
ContactIdStringTrueContacts.IdNoThe ContactId column of the TrackingLogs table.
HashStringTrueNoThe Hash column of the TrackingLogs table.
ContactLinkStringTrueNoThe ContactLink column of the TrackingLogs table.
SubscriberidLinkStringTrueNoThe SubscriberidLink column of the TrackingLogs table.
TstampLinkDatetimeTrueNoThe TstampLink column of the TrackingLogs table.
TypeLinkStringTrueNoThe TypeLink column of the TrackingLogs table.
ValueLinkStringTrueNoThe ValueLink column of the TrackingLogs table.
UDateLinkDatetimeFalseYes

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringTrueNoThe Id column of the Users table.
EmailStringTrueNoThe Email column of the Users table.
FirstNameStringTrueNoThe FirstName column of the Users table.
LastNameStringTrueNoThe LastName column of the Users table.
ConfigsLinkStringTrueNoThe ConfigsLinks column of the Users table.
DealGroupTotalsLinkStringTrueNoThe DealGroupTotalsLink column of the Users table.
DealGroupUsersLinkStringTrueNoThe DealGroupUsersLink column of the Users table.
ListsLinkStringTrueNoThe ListsLink column of the Users table.
UserGroupLinkStringTrueNoThe UserGroupLink column of the Users table.
PhoneUnknownTrueNoThe Phone column of the Users table.
SignatureUnknownTrueNoThe Signature column of the Users table.
UsernameStringTrueNoThe Username column of the Users table.

Return to Top