API Data Provider - Online Help

Connecting to GetResponse

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

Using Token Authentication

GetResponse uses an X-Auth-Token to control access to the API. This token can be found under 'My account' > 'Use GetResponse API'. You can set the the APIKey to this X-Auth-Token in the ProfileSettings connection property.

Example connection string

Profile=C:\profiles\GetResponse.apip;ProfileSettings='ApiKey=my_x-auth-token';

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;

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 or OAuth.
Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
CallbackURL Identifies the URL users return to after authenticating to API via OAuth (Custom OAuth applications only).
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.).
Scope Scope(s) to use when authenticating, that control access to specific information.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539.0