This method returns your personal information. (https://app.getresponse.com/account.html#account-details)

We want to point out that although request url is given in plural form (like always in this API) this is the only resource that always "one". You cannot get more than one resource of that type.

 

Returns status code

200

Request url

/accounts

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

{
    "accountId": "B",
    "firstName": "John",
    "lastName": "Smith",
    "email": "jsmith@example.com",
    "phone": "0417123456",
    "companyName": "Example Company",
    "state": "State",
    "city": "Gdansk",
    "zipCode": "11132",
    "countryCode": {
        "countryCodeId": "175",
        "countryCode": "PL"
    },
    "industryTag": {
        "industryTagID": "1"
    },
    "numberOfEmployees": "5",
    "timeFormat": "24h",
    "timeZone": {
        "name": "Europe/Warsaw",
        "offset": "+01:00"
    },
    "href": "https://api.getresponse.com/v3/accounts"
}

Update accounts information.

 

Important:

  • In order to change country you need to contact GetResponse support
  • In order to change email address you need to login inot your account and change it in 'Account' section (needs approval)

Returns status code

200

Example Request Body

{
    "firstName": "John",
    "lastName": "Smith",
    "phone": "0417123456",
    "companyName": "GetResponse",
    "street": "Arkonska",
    "state": "Pomorskie",
    "city": "Gda\u0144sk",
    "zipCode": "42836",
    "timeFormat": "25h",
    "numberOfEmployees": "100"
}

Body params

Field nameField typeField description
firstNamestringFirst name, length 2-64
lastNamestringLast name, length 2-64
phonestringPhone, length 2-32
companyNamestringCompany name, length 0-64
streetstringStreet, length 2-64
statestringState, length 0-40
citystringCity
zipCodestringzip code, length 2-9
timeFormatstringTime format (Fixed values to choose from: 12h, 24h)
numberOfEmployeesstringNumber of employees in Your company

Example Response

{
    "accountId": "B",
    "firstName": "John",
    "lastName": "Smith",
    "email": "jsmith@example.com",
    "phone": "0417123456",
    "companyName": "Example Company",
    "state": "State",
    "city": "Gdansk",
    "zipCode": "11132",
    "countryCode": {
        "countryCodeId": "232"
    },
    "industryTag": {
        "industryTagID": null
    },
    "numberOfEmployees": "500",
    "timeFormat": "12h",
    "href": "http://api.getresponse.com/v3/account/B"
}

This method returns your billing information. (https://secure.getresponse.com/upgrade/en)

Returns status code

200

Request url

/accounts/billing

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

{
    "listSize": "2500",
    "paymentPlan": "Monthly",
    "subscriptionPrice": 25,
    "renewalDate": "2014-10-08",
    "currencyCode": "USD",
    "accountBalance": "-15.00",
    "price": 25,
    "paymentMethod": "credit_card",
    "creditCard": {
        "number": "XXXXXXXXX0123",
        "expirationDate": "2015-12-31"
    },
    "addons": [
        {
            "name": "Landing Page Creator",
            "price": 15,
            "active": "true"
        }
    ]
}

This request returns history of login's for this account. (https://app.getresponse.com/account.html#login-history)

Returns status code

200

Request url

/accounts/login-history?fields=loginTime&page=4&perPage=20

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma
perPageintNumber results on page
pageintPage number

Example Response

{
    "results": [
        {
            "loginTime": "2014-10-09 08:00:0",
            "logoutTime": null,
            "isSuccessful": "false",
            "ip": "192.0.2.1"
        }
    ]
}

Method returns current status of your GetResponse badge. Details can be found here: https://app.getresponse.com/account.html#badge

 

Returns status code

200

Example Response

{
    "status": "disabled"
}

Can turn on/off the GetResponse Badge. Details can be found here: https://app.getresponse.com/account.html#badge

Returns status code

200

Example Request Body

{
    "status": "disabled"
}

Body params

Field nameField typeField description
status (required)stringIs GetResponse logo badge turned on or off

Example Response

{
    "status": "disabled"
}

This method returns an useful list of industryTags that can be used in other calls

Returns status code

200

Request url

/accounts/industries?fields=name

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

[
    {
        "industryTagId": 1,
        "name": "Agencies",
        "description": "Looking for creative services, a great web designer or a public relations agency to support your business? Browse our collection of attractive and targeted agency newsletters (after all, they should speak for themselves!) and find the services you need."
    },
    {
        "industryTagId": 2,
        "name": "Arts & Entertainment",
        "description": "If you\u2019re an art collector, a business in need of visual design services, or researching entertainment for a special event, you\u2019ll find our customers are not only talented, but great communicators. Check out their newsletters for portfolio samples, videos, testimonials \u2212 and other wonders."
    }
]

This method returns an list of all different timezones.

Returns status code

200

Request url

/accounts/timezones?fields=name

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

[
    {
        "timezoneId": 1,
        "name": "Asia/Kabul",
        "offset": "+04:30",
        "country": "Afghanistan"
    }
]

This request will fetch global blacklist. (https://app.getresponse.com/list_hygiene.html)

Returns status code

200

Request url

/accounts/blacklists?query[mask]=@gmail.com

Request params

Field nameField typeField description
maskstringBlacklist mask to search for

Example Response

{
    "masks": [
        "@gmail.com",
        "test@qqmail.com"
    ]
}

This request will update global blacklist. (https://app.getresponse.com/list_hygiene.html).

As in the case of campaign blacklist, you should send complete list with that request, we just simply replace current blacklist with whatever you will send to us in this request.

Returns status code

200

Example Response

{
    "masks": [
        "@gmail.com",
        "test@qqmail.com"
    ]
}

Method returns current callback configuration or 404 response if the callbacks are not enabled.

Returns status code

200

Example Response

{
    "url": "https://example.com/callback",
    "actions": {
        "open": true,
        "click": false,
        "goal": false,
        "subscribe": true,
        "unsubscribe": true,
        "survey": false
    }
}

Enables callbacks or updates callback configuration. You can omit fields that are not supposed to be updated. Default action's status is false (disabled).

Returns status code

200

Example Request Body

{
    "url": "https://example.com/callback",
    "actions": {
        "open": false,
        "click": true,
        "goal": true,
        "subscribe": false,
        "unsubscribe": false,
        "survey": true
    }
}

Body params

Field nameField typeField description
urlstringURL to use to post notifications, required if callbacks are not yet enabled
actionsobjectStatus of callback actions
Field nameField typeField description
openbooleanIs `open` callback enabled
clickbooleanIs `click` callback enabled
goalbooleanIs `goal` callback enabled
subscribebooleanIs `subscribe` callback enabled
unsubscribebooleanIs `unsubscribe` callback enabled
surveybooleanIs `survey` callback enabled

Example Response

{
    "url": "https://example.com/callback",
    "actions": {
        "open": false,
        "click": true,
        "goal": true,
        "subscribe": false,
        "unsubscribe": false,
        "survey": true
    }
}

Disables callbacks and removes callback configuration. Returns 404 response if callbacks were not enabled.

Returns status code

204

Possible Errors