Skip to main content
GetResponse supports two authentication methods. Choose the one that best fits your use case:
  • API Key Authentication - Best for internal integrations and quick setup
  • OAuth 2.0 Authentication - Best for third-party applications accessing user accounts

​
API Key Authentication

To setup your GetResponse app in Refold for API Key, you will need the following credentials from your GetResponse account:
  • API Key

​
Pre-requisites

  1. GetResponse account with API access.
API keys expire after 90 days if unused. When that happens, you’ll need to generate a new key to continue using the API.

​
Getting API credentials in GetResponse

To acquire the above mentioned credentials from GetResponse, please follow the steps mentioned below:
  1. Log in to your GetResponse account at https://app.getresponse.com.
  2. Navigate to Tools → Integrations and API → API in the menu.
Navigation for API setup
  1. Click on the Generate API key button to create a new API key.
  2. Enter a descriptive Name for your API key to identify its purpose.
  3. Click Generate to create the API key.
  4. Copy the generated API Key immediately and store it securely.
Setting up GetResponse API Key
  1. The API uses a custom header format: X-Auth-Token: api-key YOUR_API_KEY.
  2. The API base URL is https://api.getresponse.com/v3/.
Getting API Key Credentials
Keep your API key secret like a password — don’t share it with anybody. Unused API keys expire after 90 days, and you’ll need to generate a new key when that happens.

​
Configuring API Key credentials in Refold

App settings page lets you configure the authentication settings for an API Key based application. For your customers to provide you authorization to access their data, they would first need to install your application. This page lets you set up your application credentials. Setting up API Key credentials Provide the acquired API Key under Settings of the app and save it.

​
OAuth 2.0 Authentication

To setup your GetResponse app in Refold for OAuth, you will need the following credentials from your GetResponse Developer account:
  • Client ID
  • Client Secret
  • Scopes

​
Pre-requisites

  1. GetResponse account with access to create OAuth applications.
If you haven’t already created an app in GetResponse, you’d need to create one. GetResponse supports Authorization Code, Client Credentials, Implicit, and Refresh Token OAuth flows.

​
Creating an app in GetResponse

To create a GetResponse app and acquire the above mentioned credentials, please follow the steps mentioned below:
  1. Log in to your GetResponse account at https://app.getresponse.com.
  2. Navigate to https://app.getresponse.com/authorizations to access the Connected Applications page.
Navigation for OAuth App setup
  1. Click on Add new application to create a new OAuth application.
  2. Enter a Name, Description, and upload a Logo for your application.
  3. Enter a Redirect URL - this is the URL to which GetResponse will redirect users during the authorization process.
  4. Go to your Apps catalog in Refold > Search for GetResponse > Settings > Use your credentials > Callback Url > Copy it.
  5. Paste the Callback Url in the Redirect URL field in GetResponse > Click Save or Add.
Setting up GetResponse OAuth app
  1. Once the application is registered, click on the app name to view your Client ID and Client Secret Key.
Getting OAuth Credentials

​
Configuring OAuth credentials in Refold

App settings page lets you configure the authentication settings for an OAuth2 based application. For your customers to provide you authorization to access their data, they would first need to install your application. This page lets you set up your application credentials. Setting up OAuth credentials Provide the acquired Client ID and Client Secret under Settings of the app and save it.

​
Configuring Scopes

Refold lets you configure what permissions to ask from your users while they install your application. The scopes can be added or removed from the App settings page, under Permissions & Scopes section. For some applications Refold sets mandatory scopes which cannot be removed. Additional scopes can be selected from the drop down. Refold also has the provision to add any custom scopes supported by the respective platform. OAuth Scopes Once the scopes has been added to the application in Refold, ensure your GetResponse OAuth application has the necessary permissions configured. GetResponse OAuth tokens provide access based on the account permissions of the authorizing user.
If you are facing scopes missing or invalid scope error. Make sure you are not passing any custom scope not supported by the platform. And, the scopes selected here are identical to the ones selected in the platform.

​
Actions and triggers

Once the above setup is completed, you can create orchestrations of your use-cases using GetResponse actions and triggers. Following are the set of GetResponse actions and triggers supported by Refold.
  1. List Campaigns - List all campaigns in GetResponse.
  2. Create Campaign - Create a new campaign in GetResponse.
  3. Update Campaign - Update an existing campaign in GetResponse.
  1. List Contacts - List all contacts in GetResponse.
  2. Create Contact - Create a new contact in GetResponse.
  3. Update Contact - Update an existing contact in GetResponse.
  4. Get Contact by ID - Get a contact by ID in GetResponse.
  1. Create Tag - Create a new tag in GetResponse.
  2. Update Tag - Update an existing tag in GetResponse.
  1. HTTP Request - Make HTTP API calls to any GetResponse documented REST APIs.
  2. Incremental Sync - Check for new data in the endpoint.