Connecting to GetResponse

To authenticate to GetResponse, you can use API Key authentication or the OAuth standard. Use API Key authentication to connect to your own data. Use OAuth to allow other users to connect to their data.

Using API Key Authentication

GetResponse uses an X-Auth-Token header to control access to the API. Your API key can be found under My account > Use GetResponse API. Set AuthScheme to APIKey and set APIKey to your API key value.

Example connection string

Profile=C:\profiles\GetResponse.apip;AuthScheme=APIKey;APIKey=my_api_key;

Using OAuth Authentication

First, you will need to register and set up the GetResponse API OAuth application. You can find the client credentials of your application and manage other options in your GetResponse App Console.

After setting the following connection properties, you are ready to connect:

AuthScheme: Set this to OAuth.
OAuthClientID: Set this to the client ID that you received upon app registration.
OAuthClientSecret: Set this to the client secret that you received upon app registration.
CallbackURL: Set this to the Redirect URI that you specified in your app.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage how the driver obtains and refreshes the OAuthAccessToken.

Example connection string

Profile=C:\profiles\GetResponse.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Available Tables

The GetResponse API Profile provides access to the following tables:

AccountBilling: Returns billing information for the account.
AccountBlacklist: Returns the global account blacklist.
AccountLoginHistory: Returns the login history for the account.
AccountTimezones: Returns the list of all available timezones.
Accounts: Returns account details for the authenticated user.
AccountsBadge: Returns the current badge status for the account.
AccountsCallbacks: Returns the current callback configuration for the account.
AccountsIndustries: Returns the list of industry tags available for use in other calls.
Addresses: Returns the collection of address resources.
AutoresponderStatistics: Returns statistics for a specific autoresponder. Requires AutoresponderId.
Autoresponders: Returns the collection of autoresponders.
AutorespondersStatistics: Returns statistics grouped by autoresponder. Requires AutoresponderId or CampaignId.
CampaignBlacklist: Returns the blacklist masks for a specific campaign. Requires CampaignId.
CampaignContacts: Returns all contacts belonging to a specific campaign. Requires CampaignId.
Campaigns: Returns the collection of campaigns.
CampaignsStatisticBalance: Returns subscription balance statistics for campaigns. Requires CampaignId.
CampaignsStatisticListsize: Returns subscriber count statistics grouped by time period. Requires CampaignId.
CampaignsStatisticLocations: Returns subscriber location statistics for campaigns. Requires CampaignId.
CampaignsStatisticOrigin: Returns subscription origin statistics for campaigns. Requires CampaignId.
CampaignsStatisticRemovals: Returns the number of and reasons for subscriber removals. Requires CampaignId.
CampaignsStatisticSubscriptions: Returns subscription statistics grouped by campaign. Requires CampaignId.
CampaignsStatisticSummary: Returns a summary of current basic statistics for campaigns.
Carts: Returns the collection of shopping carts for a specific shop. Requires ShopId.
Categories: Returns the collection of product categories for a specific shop. Requires ShopId.
ContactActivites: Returns recent activities for a specific contact (last 14 days by default). Requires Contactid.
Contacts: Returns the collection of contacts.
CustomFields: Returns all custom fields defined for the account.
FormVariants: Returns the A/B test variants for a specific form. Requires FormId.
Forms: Returns the collection of forms.
FormsFields: Returns all sender (from) email fields defined for the account.
GoalProfiles: Returns the collection of goal profiles.
GoalprofilesIdGoals: Returns the goals for a specific goal profile. Requires GoalProfileId.
GoalsprofilesIdGoalsId: Returns a single goal within a goal profile. Requires GoalProfileId and GoalId.
Imports: Returns the collection of contact import records.
LandingPages: Returns the collection of landing pages.
MetaFields: Returns the meta-fields for a specific shop. Requires ShopId.
Multimedia: Returns the collection of multimedia files.
NewsLettersStatistics: Returns statistics for newsletters, optionally filtered by NewsletterId or CampaignId.
NewsletterIdStatistics: Returns statistics for a single newsletter. Requires NewsletterId.
Newsletters: Returns the collection of newsletters.
Orders: Returns the collection of orders for a specific shop. Requires ShopId.
Pipelines: Returns the collection of automation pipelines.
PipelinesIdStages: Returns the stages for a specific pipeline. Requires PipeLineId.
ProductVariants: Returns the variants for a specific product in a shop. Requires ShopId and ProductId.
Products: Returns the collection of products for a specific shop. Requires ShopId.
RssNewsLetterStatistics: Returns statistics for RSS newsletters, optionally filtered by RssNewsLetterId or CampaignId.
RssNewsLetters: Returns the collection of RSS newsletters.
SearchContact: Returns a single saved contact search segment. Requires SearchContactId.
SearchContacts: Returns the collection of saved contact search segments.
SearchContactsIdContacts: Returns the contacts matching a saved search segment. Requires SearchContactId.
Shops: Returns the collection of e-commerce shops.
SubscriptionConfirmationBody: Returns the subscription confirmation email body for a specific language. Requires LanguageCode.
SubscriptionConfirmationSubject: Returns the subscription confirmation email subjects for a specific language. Requires LanguageCode.
Suppressions: Returns the collection of suppression lists.
Tags: Returns the collection of contact tags.
Taxes: Returns the tax rates for a specific shop. Requires ShopId.
WebForms: Returns the collection of web forms.
Webinars: Returns the collection of webinars.
WorkFlow: Returns the collection of automation workflows.

Usage Examples

AccountBilling:

SELECT * FROM AccountBilling

AccountBlacklist:

SELECT * FROM AccountBlacklist

AccountLoginHistory:

SELECT * FROM AccountLoginHistory

AccountTimezones:

SELECT * FROM AccountTimezones

Accounts:

SELECT * FROM Accounts

AccountsBadge:

SELECT * FROM AccountsBadge

AccountsCallbacks:

SELECT * FROM AccountsCallbacks

AccountsIndustries:

SELECT * FROM AccountsIndustries

Addresses:

SELECT * FROM Addresses

SELECT * FROM Addresses WHERE Name = 'Main Office'

AutoresponderStatistics:

SELECT * FROM AutoresponderStatistics WHERE AutoresponderId = 'your_autoresponder_id'

Autoresponders:

SELECT * FROM Autoresponders

SELECT AutoresponderId, Name, Status, Subject FROM Autoresponders WHERE Status = 'enabled'

AutorespondersStatistics:

SELECT * FROM AutorespondersStatistics WHERE AutoresponderId = 'your_autoresponder_id'

SELECT * FROM AutorespondersStatistics WHERE CampaignId = 'your_campaign_id'

CampaignBlacklist:

SELECT * FROM CampaignBlacklist WHERE CampaignId = 'your_campaign_id'

CampaignContacts:

SELECT * FROM CampaignContacts WHERE CampaignId = 'your_campaign_id'

SELECT ContactId, Name, Email, CreatedOn FROM CampaignContacts WHERE CampaignId = 'your_campaign_id'

Campaigns:

SELECT * FROM Campaigns

SELECT CampaignId, Name, Description, CreatedOn FROM Campaigns

CampaignsStatisticBalance:

SELECT * FROM CampaignsStatisticBalance WHERE CampaignId = 'your_campaign_id'

CampaignsStatisticListsize:

SELECT * FROM CampaignsStatisticListsize WHERE CampaignId = 'your_campaign_id'

CampaignsStatisticLocations:

SELECT * FROM CampaignsStatisticLocations WHERE CampaignId = 'your_campaign_id'

CampaignsStatisticOrigin:

SELECT * FROM CampaignsStatisticOrigin WHERE CampaignId = 'your_campaign_id'

CampaignsStatisticRemovals:

SELECT * FROM CampaignsStatisticRemovals WHERE CampaignId = 'your_campaign_id'

CampaignsStatisticSubscriptions:

SELECT * FROM CampaignsStatisticSubscriptions WHERE CampaignId = 'your_campaign_id'

CampaignsStatisticSummary:

SELECT * FROM CampaignsStatisticSummary

SELECT * FROM CampaignsStatisticSummary WHERE CampaignId = 'your_campaign_id'

Carts:

SELECT * FROM Carts WHERE ShopId = 'your_shop_id'

SELECT CartId, ContactId, TotalPrice, Currency FROM Carts WHERE ShopId = 'your_shop_id'

Categories:

SELECT * FROM Categories WHERE ShopId = 'your_shop_id'

ContactActivites:

SELECT * FROM ContactActivites WHERE Contactid = 'your_contact_id'

SELECT Activity, Subject, CreatedOn FROM ContactActivites WHERE Contactid = 'your_contact_id'

Contacts:

SELECT * FROM Contacts

SELECT ContactId, Name, Email, CreatedOn FROM Contacts WHERE CampaignId = 'your_campaign_id'

CustomFields:

SELECT * FROM CustomFields

SELECT CustomFieldId, Name, FieldType, ValueType FROM CustomFields

FormVariants:

SELECT * FROM FormVariants WHERE FormId = 'your_form_id'

Forms:

SELECT * FROM Forms

SELECT FormId, Name, Status, CreatedOn FROM Forms WHERE CampaignId = 'your_campaign_id'

FormsFields:

SELECT * FROM FormsFields

SELECT FromFieldId, Email, Name, IsDefault FROM FormsFields

GoalProfiles:

SELECT * FROM GoalProfiles

SELECT GoalProfileId, Name, DomainUrl, CreatedOn FROM GoalProfiles

GoalprofilesIdGoals:

SELECT * FROM GoalprofilesIdGoals WHERE GoalProfileId = 'your_goal_profile_id'

GoalsprofilesIdGoalsId:

SELECT * FROM GoalsprofilesIdGoalsId WHERE GoalProfileId = 'your_goal_profile_id' AND GoalId = 'your_goal_id'

Imports:

SELECT * FROM Imports

SELECT ImportId, Status, CreatedOn, FinishedOn FROM Imports

LandingPages:

SELECT * FROM LandingPages

SELECT LandingPageId, MetaTitle, Status, CreatedOn FROM LandingPages WHERE CampaignId = 'your_campaign_id'

MetaFields:

SELECT * FROM MetaFields WHERE ShopId = 'your_shop_id'

Multimedia:

SELECT * FROM Multimedia

SELECT ImageId, Name, Extension, Size FROM Multimedia

NewsLettersStatistics:

SELECT * FROM NewsLettersStatistics WHERE NewsletterId = 'your_newsletter_id'

SELECT * FROM NewsLettersStatistics WHERE CampaignId = 'your_campaign_id'

NewsletterIdStatistics:

SELECT * FROM NewsletterIdStatistics WHERE NewsletterId = 'your_newsletter_id'

Newsletters:

SELECT * FROM Newsletters

SELECT NewsletterId, Name, Subject, Status, SendOn FROM Newsletters WHERE CampaignId = 'your_campaign_id'

Orders:

SELECT * FROM Orders WHERE ShopId = 'your_shop_id'

SELECT OrderId, Status, TotalPrice, Currency, CreatedOn FROM Orders WHERE ShopId = 'your_shop_id'

Pipelines:

SELECT * FROM Pipelines

SELECT PipelineId, Name FROM Pipelines

PipelinesIdStages:

SELECT * FROM PipelinesIdStages WHERE PipeLineId = 'your_pipeline_id'

ProductVariants:

SELECT * FROM ProductVariants WHERE ShopId = 'your_shop_id' AND ProductId = 'your_product_id'

SELECT VariantId, Name, Price, Quantity, Sku FROM ProductVariants WHERE ShopId = 'your_shop_id' AND ProductId = 'your_product_id'

Products:

SELECT * FROM Products WHERE ShopId = 'your_shop_id'

SELECT ProductId, Name, Type, Vendor, CreatedOn FROM Products WHERE ShopId = 'your_shop_id'

RssNewsLetterStatistics:

SELECT * FROM RssNewsLetterStatistics WHERE RssNewsLetterId = 'your_rss_newsletter_id'

SELECT * FROM RssNewsLetterStatistics WHERE CampaignId = 'your_campaign_id'

RssNewsLetters:

SELECT * FROM RssNewsLetters

SELECT RssNewsletterId, Name, Subject, Status, RssFeedUrl FROM RssNewsLetters

SearchContact:

SELECT * FROM SearchContact WHERE SearchContactId = 'your_search_contact_id'

SearchContacts:

SELECT * FROM SearchContacts

SELECT SearchContactId, Name, CreatedOn FROM SearchContacts WHERE Name = 'my_segment'

SearchContactsIdContacts:

SELECT * FROM SearchContactsIdContacts WHERE SearchContactId = 'your_search_contact_id'

Shops:

SELECT * FROM Shops

SELECT ShopId, Name, Locale, Currency, CreatedOn FROM Shops

SubscriptionConfirmationBody:

SELECT * FROM SubscriptionConfirmationBody WHERE LanguageCode = 'EN'

SubscriptionConfirmationSubject:

SELECT * FROM SubscriptionConfirmationSubject WHERE LanguageCode = 'EN'

Suppressions:

SELECT * FROM Suppressions

SELECT SuppressionId, Name, CreatedOn FROM Suppressions

Tags:

SELECT * FROM Tags

SELECT TagId, Name, Color FROM Tags

Taxes:

SELECT * FROM Taxes WHERE ShopId = 'your_shop_id'

SELECT TaxId, Name, Rate FROM Taxes WHERE ShopId = 'your_shop_id'

WebForms:

SELECT * FROM WebForms

SELECT WebformId, Name, Status, ModifiedOn FROM WebForms WHERE CampaignId = 'your_campaign_id'

Webinars:

SELECT * FROM Webinars

SELECT WebinarId, Name, Status, StartsOn FROM Webinars WHERE CampaignId = 'your_campaign_id'

WorkFlow:

SELECT * FROM WorkFlow

SELECT WorkflowId, Name, Status, DateStart FROM WorkFlow

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
APIKey	The API Key in your GetResponse account.
AuthScheme	The scheme used for authentication. Accepted entries are None, APIKey, or OAuth. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD
CallbackURL	Identifies the URL users return to after authenticating to API via OAuth (Custom OAuth applications only).
InitiateOAuth	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. Allowed values are: OFF, REFRESH, GETANDREFRESH
OAuthAccessToken	Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthExpiresIn	Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthRefreshToken	Specifies the OAuth refresh token used to request a new access token after the original has expired.
OAuthSettingsLocation	Specifies the location of the settings file where OAuth values are saved.
OAuthTokenTimestamp	Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.
OAuthVerifier	Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.
Scope	Scope(s) to use when authenticating, that control access to specific information.