GR API Docs

API Collections ​

To help you get started faster with the GetResponse API, we provide ready-to-use collections for the most popular API client tools: Postman, Bruno and the JetBrains IDEs HTTP Client (.http files).

Each collection contains a set of pre-configured requests covering the GetResponse API v3 endpoints, so you can explore and test the API without writing any code.

Postman collection ​

Postman is a popular API platform for building and using APIs.

How to use it ​

  1. Download and unzip the collection.
  2. Open Postman and go to Import.
  3. Select the extracted .json file.
  4. Set up your X-Auth-Token (or OAuth 2.0) authentication as described in the Authentication section.

Example environment ​

The collection uses Postman environment variables so you don't have to hardcode your credentials in every request. Below is an example environment file — create your own with these variables (values are anonymized, so replace them with your own data):

json
{
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "GetResponse API",
    "values": [
        {
            "key": "url",
            "value": "https://api.getresponse.com",
            "enabled": true
        },
        {
            "key": "token",
            "value": "your-api-key",
            "enabled": true
        },
        {
            "key": "domain",
            "value": "your-domain.com",
            "enabled": true
        }
    ],
    "_postman_variable_scope": "environment",
    "_postman_exported_at": "2024-01-01T00:00:00.000Z",
    "_postman_exported_using": "Postman/11.0.0"
}
  • url — the base URL of the API you want to call, e.g. https://api.getresponse.com (GetResponse MAX clients should use their own API domain, e.g. https://api3.getresponse360.pl).
  • token — your API key, used in the X-Auth-Token header as described in the Authentication section.
  • domain — required for GetResponse MAX clients only. Your account's domain, sent in the X-Domain header. See the GetResponse MAX section for details.

NOTE

You can import this file as a new environment in Postman (Environments > Import), or create a new environment manually and add these variables yourself.

Bruno collection ​

Bruno is a fast, open-source, git-friendly API client — an alternative to Postman.

How to use it ​

  1. Download and unzip the collection.
  2. Open Bruno and choose Open Collection.
  3. Select the extracted collection folder.
  4. Set up your X-Auth-Token (or OAuth 2.0) authentication as described in the Authentication section.

Example environment ​

Bruno also uses environments to store variables like your API key, so you don't have to hardcode them in every request. The same url, token and domain variables described in the Postman example environment above apply here as well — only the way you set them up is different:

  1. Open the collection in Bruno.
  2. In the top-right corner, open the environment selector and choose Configure.
  3. Create a new environment (or select an existing one bundled with the collection) and add the url, token and domain variables with your own values.
  4. Save the environment and select it from the environment selector so it's used for your requests.

HTTP Client collection ​

The HTTP Client is a tool built into JetBrains IDEs (e.g. PhpStorm, IntelliJ IDEA) that lets you create, edit and run HTTP requests directly from .http files, without leaving the IDE.

How to use it ​

  1. Download and unzip the collection.
  2. Open the extracted http folder in your JetBrains IDE.
  3. Open any .http file - each one corresponds to a group of requests (e.g. Contacts.http, Campaigns (Lists).http).
  4. Set up your API key as described below, then select the dev environment from the dropdown available in the .http file editor before running a request.

Example environment ​

The collection comes with two environment files:

  • http-client.env.json - contains the public baseUrl variable.
  • http-client.private.env.json - contains the token variable (your API key).

Open http-client.private.env.json and replace the YOUR_API_KEY_HERE value with your real API key, as described in the Authentication section. This file should not be shared or committed with a real key.

NOTE

Some requests use path variables, e.g. {{contactId}}, {{campaignId}}, etc. Their values are not predefined in the environment - at the top of each .http file that uses them, there is a declaration such as @campaignId = {your campaignId id}. Replace the value after the = sign with your own ID so requests in that file can use it.

NOTE

All collections are updated occasionally and might not include the newest endpoints.