GetResponse
Add contacts and trigger autoresponders and email marketing campaigns via the GetResponse API v3.
In GetResponse a campaign is a contact list. Adding a contact to a campaign
(list) enrolls them in that list's autoresponders and automation — so
create-contact is both how you grow a list and how you fire its autoresponder
sequence.
- Base URL:
https://api.getresponse.com/v3 - Auth:
X-Auth-Token: api-key <apiKey>(plain API key — no OAuth) - Credential-based: no (pass the key as the
apiKeyinput)
Operations
| operation | method & path | purpose |
|---|---|---|
get-contacts |
GET /contacts |
List contacts; filter by email or campaignId |
create-contact |
POST /contacts |
Add a contact to a campaign (list); triggers that list's autoresponders |
get-campaigns |
GET /campaigns |
List campaigns (contact lists) |
get-autoresponders |
GET /autoresponders |
List autoresponders |
get-newsletters |
GET /newsletters |
List newsletters (broadcast emails) |
Inputs
| input | required | used by | notes |
|---|---|---|---|
apiKey |
yes | all | GetResponse API key |
operation |
yes | all | one of the operations above |
email |
create-contact | get-contacts, create-contact | contact email |
campaignId |
create-contact | get-contacts, create-contact | campaign/list id |
name |
no | create-contact | contact name |
dayOfCycle |
no | create-contact | autoresponder day-of-cycle start |
perPage |
no | all GETs | results per page (max 1000, default 100) |
page |
no | all GETs | page number (1-based) |
The tool always publishes result (the raw JSON response body as a string) and
status (the HTTP status code). POST /contacts returns 202 Accepted with
an empty body on success — the add is queued asynchronously.
API key setup
- Log in to GetResponse.
- Go to Tools > Integrations & API > API.
- Click Generate API key, name it, and copy the key.
- Pass that value as the
apiKeyinput.
The key is sent in the X-Auth-Token header as api-key <key>.
Examples
List the first 50 contacts:
operation = get-contacts
apiKey = <your key>
perPage = 50
Add a contact to a list (fires its autoresponders):
operation = create-contact
apiKey = <your key>
email = [email protected]
name = Jane Doe
campaignId = aBcDe
Inspect your autoresponders:
operation = get-autoresponders
apiKey = <your key>