Getting started
GetResponse API 3.0 lets you manage your GetResponse account using automated tools and scripts to run your marketing campaigns. Quickly get access to the information you need to manage your contact lists and target just the right contacts. Create forms and landing pages to grow your lists. Send emails to keep your contacts informed about your offer. Send ecommerce data to GetResponse to use insights on what your customers buy to reward them and keep them coming back to your store.
In this section we help you get started with our API. You can always return here whenever you need a refresher. You can also use it for reference when going over our case studies.
Before you begin
To use the GetResponse API, you should have experience working with RESTful APIs. You don’t have to be a formally-trained developer or engineer, but you do need to feel comfortable working with custom API solutions.
If you don’t have a passion for these things, don’t worry. There is a way that doesn’t involve using our API directly. Search our integrations directory for a plugin or integration that you can use.
What you’ll need
- A GetResponse account
- The API key generated for the account (see Authentication)
- A tool that allows you to make HTTP requests, such as Postman
Now, let’s go over the things you should know before getting started!
API endpoint
There are 3 different URLs for the GetResponse APIv3:
- https://api.getresponse.com/v3/ - for all customers except GetResponse MAX
- https://api3.getresponse360.com/v3/ - for GetResponse MAX customers
- https://api3.getresponse360.pl/v3/ - for GetResponse MAX customers
Note: GetResponse MAX customers should contact their Account Managers to find out which of the two GetResponse MAX endpoints they should use.
Headers
Request
Authentication
All APIv3 requests require an authentication header corresponding to the selected authentication method:
X-Auth-Token
for API key-based authenticationAuthorization
Basic
to get or refresh a token in selected OAuth requestsBearer
for OAuth token authenticated requests
Authentication errors return as the HTTP status code 401 and authorization errors as the HTTP status code 403.
Content-Type
POST requests require the Content-Type
header to be set to application/json
.
X-Domain
The X-Domain header is required only for GetResponse MAX customers. It should not be used by other customers.
If required, the X-Domain header must be set to the domain associated with the given GetResponse MAX account, e.g. X-Domain: example.com
. It must not contain the www.
prefix or the URI scheme (such as http://
).
Response
Throttling
Please refer to the Limits and throttling documentation for more information.
Pagination
Paginated resources are returned with the following custom headers:
CurrentPage
- current pageTotalPages
- total pagesTotalCount
- the total number of resources found for the specified conditions
Identifiers - IDs
All resource identifiers used in the API are string values, not numbers.
Support
API Support is provided through the DevZone support channel. Please do not hesitate to contact us with any problems or questions. Be sure to include the request and response data, including the headers.