Authentication

Our entire API is accessible only for authenticated users, it means that every request must be signed with your credentials. We offer couple different models for authentication (signing) requests: APIKEY and 360. APIKEY is our primary model and should be used in most cases, and for our enterprise account (360) there is one additional header that must be added to standard APIKEY authentication. Please read below for detailed information.

ApiKey

Signing request is very simple:

  • Create custom header for your request using this APIKEY
  • if your APIKEY is jfgs8jh4ksg93ban9Dfgh8, then add a following header:
X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8
  • Send this custom header in every request to our API

Example of such request would be:

curl -H "X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8" https://api.getresponse.com/v3/accounts

For 360 users only

If you are our GetReponse 360 customer, you need one additional step: sending us your domain that you registered with. You can do that by adding an additional header(assuming your GetResponse 360 domain is example.com):

X-DOMAIN: example.com

The rest of the process is exactly the same as in APIKEY model of authentication.

Remember that you should specify only domain name, without 'www' or 'http://' prefixes.

Timezone settings

The default timezone in response data is UTC.

To set a different timezone, add X-Time-Zone header with value of time zone name (TZ column).