Explore the GetResponse API data model

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

Try our interactive ERD Or, browse below

Pulling data from the GetResponse 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 GetResponse 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

Autoresponder

Documentation: https://apireference.getresponse.com/#tag/Autoresponders

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
SendSettingsSendAtHour int - -
SendSettingsTimeTravel string - -
AutoresponderID string - -
CreatedOn datetime - -
Status string - -
CampaignID string Campaign → CampaignID -
Editor string - -
Subject string - -
FromFieldFromFieldID string FromAddress → FromFieldID -
ReplyToFromFieldID string FromAddress → FromFieldID -
SendSettingsType string - -
SendSettingsDelayInHours int - -
SendSettingsRecurrence string - -
StatisticsDelivered int - -
StatisticsOpenRate decimal - -
StatisticsClickRate decimal - -

Campaign

Documentation: https://apireference.getresponse.com/#tag/Campaigns-(Lists)

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Description string - -
ConfirmationFromFieldFromFieldID string FromAddress → FromFieldID -
ConfirmationReplyToFromFieldID string FromAddress → FromFieldID -
SubscriptionConfirmationBodyID string - -
SubscriptionConfirmationSubjectID string - -
ConfirmationRedirectType string - -
ConfirmationRedirectUrl string - -
ConfirmationMimeType string - -
ProfileIndustryTagID string - -
ProfileDescription string - -
ProfileLogo string - -
ProfileLogoLinkUrl string - -
ProfileTitle string - -
AddPostalToMessages boolean - -
PostalCity string - -
PostalCompanyName string - -
PostalCountry string - -
PostalDesign string - -
PostalState string - -
PostalStreet string - -
PostalZipCode string - -
OptInTypesApi string - -
OptInTypesEmail string - -
OptInTypesImport string - -
OptInTypesWebform string - -
SubscriptionNotificationsStatus string - -
CampaignID string - -
CreatedOn datetime - -
TechName string - -
LanguageCode string - -
IsDefault boolean - -

ClickTrack

Documentation: https://apireference.getresponse.com/#tag/Click-Tracks

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
ClickTrackID string - -
Url string - -
Clicks int - -
MessageCreatedOn datetime - -
NewsletterID string Newsletter → NewsletterID -
AutoresponderID string Autoresponder → AutoresponderID -

Contact

Documentation: https://apireference.getresponse.com/#tag/Contacts

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
GeolocationLatitude string - -
GeolocationLongitude string - -
GeolocationContinentCode string - -
GeolocationCountryCode string - -
GeolocationRegion string - -
GeolocationPostalCode string - -
GeolocationDmaCode string - -
GeolocationCity string - -
ContactID string - -
CreatedOn datetime - -
ChangedOn datetime - -
Note string - -
Email string - -
Origin string - -
DayOfCycle string - -
Scoring int - -
EngagementScore int - -
CampaignID string Campaign → CampaignID -

ContactActivity

Documentation: https://apireference.getresponse.com/#operation/getActivities

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID string Contact → ContactID -
LineNumber int - -
CreatedOn datetime - -
Activity string - -
Subject string - -
PreviewUrl string - -
ClickTrackID string ClickTrack → ClickTrackID -
NewsletterID string Newsletter → NewsletterID -
AutoresponderID string Autoresponder → AutoresponderID -

CustomEvent

Documentation: https://apireference.getresponse.com/#tag/Custom-Events

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
CustomEventID string - -
CreatedOn datetime - -

CustomField

Documentation: https://apireference.getresponse.com/#tag/Custom-Fields

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
CustomFieldID string - -
Format string - -
Type string - -
ValueType string - -
Hidden boolean - -

FromAddress

Documentation: https://apireference.getresponse.com/#tag/From-Fields

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
FromFieldID string - -
CreatedOn datetime - -
IsActive boolean - -
Email string - -
RewrittenEmail string - -
IsDefault boolean - -
DomainStatus string - -
DomainDKIMWarning string - -

LandingPage

Documentation: https://apireference.getresponse.com/#tag/Landing-Pages

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
LpsID string - -
CreatedAt datetime - -
UpdatedAt datetime - -
Status string - -
DomainUrl string - -
ThumbnailUrl string - -
IsChatsEnabled boolean - -
Leads int - -

Newsletter

Documentation: https://apireference.getresponse.com/#tag/Newsletters

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
FromFieldFromFieldID string FromAddress → FromFieldID -
ReplyToFromFieldID string FromAddress → FromFieldID -
ContentPlain string - -
SendSettingsExternalLexpadDataSourceUrl string - -
SendSettingsExternalLexpadDataSourceToken string - -
NewsletterID string - -
CreatedOn datetime - -
Status string - -
SendOn datetime - -
Subject string - -
Type string - -
Editor string - -
CampaignID string Campaign → CampaignID -
SendSettingsPerfectTiming boolean - -
SendSettingsTimeTravel boolean - -
SendMetricsStatus string - -
SendMetricsSent int - -
SendMetricsTotal int - -
SendMetricsDelivered int - -
SendMetricsOpenRate decimal - -
SendMetricsClickRate decimal - -
SendMetricsHumanOpenRate decimal - -
SendMetricsHumanClickRate decimal - -

Popup

Documentation: https://apireference.getresponse.com/#tag/Forms-and-Popups

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
PopupID string - -
CreatedAt datetime - -
UpdatedAt datetime - -
Status string - -
Type string - -
ThumbnailUrl string - -
Views int - -
UniqueVisitors int - -
Leads int - -
Ctr int - -

Shop

Documentation: https://apireference.getresponse.com/#tag/Shops

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
ProductCount int - -
ProductRevenue decimal - -
RevenueCurrency string - -
ShopID string - -
CreatedOn datetime - -
UpdatedOn datetime - -
Locale string - -
Currency string - -

Suppression

Documentation: https://apireference.getresponse.com/#tag/Suppressions

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
SuppressionID string - -
CreatedOn datetime - -

Tag

Documentation: https://apireference.getresponse.com/#tag/Tags

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
TagID string - -
CreatedAt datetime - -

Website

Documentation: https://apireference.getresponse.com/#tag/Websites

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
WebsiteID string - -
CreatedAt datetime - -
UpdatedAt datetime - -
Status string - -
DomainUrl string - -
ThumbnailUrl string - -
IsChatsEnabled boolean - -
PageViews int - -
Visits int - -
UniqueVisitors int - -

Workflow

Documentation: https://apireference.getresponse.com/#tag/Workflows

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
WorkflowID string - -
Status string - -
DateStart datetime - -
DateStop datetime - -
SubscriberStatisticsCompletedCount int - -
SubscriberStatisticsInProgressCount int - -

AutoresponderFlag

Column Type Relates to Notes
RemoteID string - -
AutoresponderRemoteID string Autoresponder → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
AutoresponderID string Autoresponder → AutoresponderID -
LineNumber int - -
Flag string - -

AutoresponderClickTrack

Column Type Relates to Notes
RemoteID string - -
AutoresponderRemoteID string Autoresponder → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
AutoresponderID string Autoresponder → AutoresponderID -
ClickTrackID string ClickTrack → ClickTrackID -

ContactTag

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID string Contact → ContactID -
TagID string Tag → TagID -

ContactCustomField

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID string Contact → ContactID -
CustomFieldID string CustomField → CustomFieldID -

CustomEventAttribute

Column Type Relates to Notes
RemoteID string - -
CustomEventRemoteID string CustomEvent → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
CustomEventID string CustomEvent → CustomEventID -
CustomEventAttributeID string - -
Type string - -

CustomFieldValue

Column Type Relates to Notes
RemoteID string - -
CustomFieldRemoteID string CustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomFieldID string CustomField → CustomFieldID -
LineNumber int - -
Value string - -

LandingPageItem

Column Type Relates to Notes
RemoteID string - -
LandingPageRemoteID string LandingPage → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
LandingPageID string LandingPage → LpsID -
Uuid string - -
CreatedAt datetime - -
Status string - -
Url string - -
RedirectUrl string - -

NewsletterSelectedCampaign

Column Type Relates to Notes
RemoteID string - -
NewsletterRemoteID string Newsletter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
NewsletterID string Newsletter → NewsletterID -
CampaignID string Campaign → CampaignID -

NewsletterExcludedCampaign

Column Type Relates to Notes
RemoteID string - -
NewsletterRemoteID string Newsletter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
NewsletterID string Newsletter → NewsletterID -
CampaignID string Campaign → CampaignID -

NewsletterSelectedContact

Column Type Relates to Notes
RemoteID string - -
NewsletterRemoteID string Newsletter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
NewsletterID string Newsletter → NewsletterID -
ContactID string Contact → ContactID -

NewsletterFlag

Column Type Relates to Notes
RemoteID string - -
NewsletterRemoteID string Newsletter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
NewsletterID string Newsletter → NewsletterID -
LineNumber int - -
Flag string - -

NewsletterClickTrack

Column Type Relates to Notes
RemoteID string - -
NewsletterRemoteID string Newsletter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
NewsletterID string Newsletter → NewsletterID -
ClickTrackID string ClickTrack → ClickTrackID -

NewsletterAttachment

Column Type Relates to Notes
RemoteID string - -
NewsletterRemoteID string Newsletter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
NewsletterID string Newsletter → NewsletterID -
LineNumber int - -
FileName string - -
MimeType string - -

SuppressionMask

Column Type Relates to Notes
RemoteID string - -
SuppressionRemoteID string Suppression → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
SuppressionID string Suppression → SuppressionID -
Mask string - -

WebsitePage

Column Type Relates to Notes
RemoteID string - -
WebsiteRemoteID string Website → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
WebsiteID string Website → WebsiteID -
Uuid string - -
CreatedAt datetime - -
Status string - -
Url string - -
RedirectUrl string - -

ContactCustomFieldValue

Column Type Relates to Notes
RemoteID string - -
ContactCustomFieldRemoteID string ContactCustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactCustomFieldID string ContactCustomField → CustomFieldID -
LineNumber int - -
Value string - -

Need more?

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

Connect your own GetResponse data Querying GetResponse using regular SQL