GetResponse

Manage GetResponse email marketing: contact lists, contacts and their custom fields and activity, and newsletters - create drafts, send or schedule them, and read their statistics.

Actions

Action	What it does
Add contact	Add a contact to a list.
Create contact list	Create a contact list.
Create custom field	Create a custom field for contacts.
Create newsletter	Create a newsletter.
Delete contact	Delete a contact.
Get account	Read the GetResponse account the API key belongs to: its login email, name, company, address, country and time zone.
Get contact	Read one contact with its list, custom field values, tags and sign-up location.
Get contact list	Read one contact list with its opt-in settings (single or double, per sign-up method), confirmation email, postal address and public profile.
Get newsletter	Read one newsletter with its content, sender, tracked links, send settings and delivery numbers.
Get newsletter statistics	Read a newsletter's sends, opens, clicks, goals, forwards, unsubscribes, bounces and complaints, in total or by hour, day or month.
List contact activities	List a contact's sends, opens and clicks, newest first.
List contact lists	List the account's contact lists (GetResponse's API calls them campaigns), with each list's id, name, language and whether it is the default.
List contacts	Search contacts by email, name, list, origin or date added.
List custom fields	List the account's custom fields with each one's type, format and, for choice fields, the values it allows.
List from addresses	List the sender addresses newsletters can be sent from, with whether each is active and its domain's authentication status.
List newsletters	List newsletters and drafts with their subject, list, send date and delivery numbers.
List time zones	List the time zones GetResponse can schedule a newsletter in, each with the GetResponse time-zone id, IANA name, UTC offset and country.
Send newsletter draft	Send a draft newsletter now, or schedule it.
Set contact custom field	Add or change one custom field's value on a contact.
Update contact	Change a contact's name, email, note or autoresponder day, or move them to another list.

Add a contact to a list. GetResponse queues the contact and adds it within a few minutes; it returns no contact id, so find the contact afterwards with List contacts. On a double opt-in list the contact must confirm by email first.

Inputs

EmailemailtextRequired: The contact's email address.
Listcampaign_idtextRequired: The contact list. Pick one, or use a list id from an earlier step.
Namenametext: The contact's name, up to 128 characters.
Autoresponder dayday_of_cyclenumber: Start the contact on the list's autoresponder cycle at this day (0 is the first day). Leave empty to keep them off the cycle.From 0 to 10000.
Custom fieldscustom_fieldsobject: Values for the account's custom fields.
Sign-up IP addressip_addresstext: The IPv4 or IPv6 address the contact signed up from.
Consents to open trackingopen_tracking_consenttrue/false: Whether the contact agreed to have email opens tracked.

Outputs

campaign_idtext: The list it was queued for
emailtext: The address queued
queuedtrue/false: Always true: GetResponse accepted it for processing
status_codenumber: HTTP status, 202

Example output

{
  "campaign_id": "V",
  "email": "jane@example.com",
  "queued": true,
  "status_code": 202
}

Create contact list

Create a contact list. Contacts added to it through Lodol join straight away unless you turn on email confirmation, in which case each must click a link first and stays invisible to the API until they do.

Inputs

List namenametextRequired: 3-64 characters, unique in the account, without / \ @ [ or ].
Languagelanguage_codetext: Two-letter language code, such as en or de.
Require email confirmationrequire_api_confirmationtrue/false: Turn on for double opt-in: contacts added through the API must confirm by email before they join.Default: false.

Outputs

campaign_idtext: List id
confirmationobject: Confirmation email settings
created_ontext: When the list was created
descriptiontext: Same as the name; kept by GetResponse for compatibility
hreftext: API URL of the list
is_defaulttrue/false: Whether this is the account's default list
language_codetext: Two-letter language code
nametext: List name
optin_typesobject: Single or double opt-in, per sign-up method
postalobject: Postal address added to messages
profileobject: Public list profile
subscription_notificationsobject: Sign-up notification settings
tech_nametext: Internal list name

Example output

{
  "campaign_id": "V",
  "created_on": "2026-03-02T07:30:49+0000",
  "description": "newsletter_subscribers",
  "href": "https://api.getresponse.com/v3/campaigns/V",
  "is_default": true,
  "language_code": "EN",
  "name": "newsletter_subscribers",
  "optin_types": {
    "api": "single",
    "email": "double",
    "import": "single",
    "webform": "double"
  },
  "tech_name": "newsletter_subscribers"
}

Create custom field

Create a custom field for contacts. The name is lower-cased with spaces turned into underscores; dropdown, radio and multi-select fields need at least two values.

Inputs

NamenametextRequired: Lowercase letters, digits and underscores, unique in the account. GetResponse reserves name, email, campaign and a few other merge words.
Data typefield_typetextRequired: What kind of value the field holds.One of: string (Text), number, date, datetime (Date and time), country, currency, phone, gender, ip (IP address), url. Default: string.
Input formatfield_formattextRequired: How the field is filled in on forms.One of: text (Single-line text), textarea (Multi-line text), radio (Radio buttons), checkbox, single_select (Single-select dropdown), multi_select (Multi-select list). Default: text.
Choicesvalueslist: The values to choose from, for a radio, dropdown or multi-select field. Leave empty for the other formats.Only when Input format is Radio buttons, Single-select dropdown or Multi-select list.
Hiddenhiddentrue/false: Hide the field from sign-up forms.Default: false.

Outputs

custom_field_idtext: Custom field id
formattext: Input format, such as text or single_select
hiddentrue/false: Whether the field is hidden from forms
hreftext: API URL of the field
nametext: Name
typetext: Data type, such as string, number or date
value_typetext: Value type
valueslist: Allowed values, for choice fields

Example output

{
  "custom_field_id": "pas",
  "format": "text",
  "hidden": false,
  "href": "https://api.getresponse.com/v3/custom-fields/pas",
  "name": "favourite_colour",
  "type": "string",
  "value_type": "string",
  "values": []
}

Create a newsletter. Save it as a draft, or send it to one or more lists now or at a scheduled time. Sending emails real people. GetResponse allows 256 of these calls a day.

Inputs

SubjectsubjecttextRequired: The subject line, 2-128 characters.
Listcampaign_idtextRequired: The list the newsletter belongs to.
From addressfrom_field_idtextRequired: The sender. Only active addresses are listed.
HTML contenthtmltext: The HTML body. Give this, the plain text, or both.
Plain-text contentplaintext: The plain-text body.
What to domodetext: Save a draft, or send the newsletter.One of: draft (Save as a draft (nothing is sent)), broadcast (Send it (now, or at the scheduled time)). Default: draft.
Send to listsrecipient_campaign_idslist: The lists that receive it. Defaults to the newsletter's list.Only when What to do is Send it (now, or at the scheduled time).
Send atsend_atdate and time: Schedule the send. Leave empty to send now.Only when What to do is Send it (now, or at the scheduled time).
Schedule time zonetime_zone_idtext: The zone GetResponse records the schedule in; the send happens at the moment picked either way. Defaults to UTC.Only when What to do is Send it (now, or at the scheduled time).
Internal namenametext: A name only you see. Defaults to the subject.
Reply-to addressreply_to_idtext: Where replies go, if not the from address.
Track openstrack_openstrue/false: Track who opens it. On by default.Default: true.
Track clickstrack_clickstrue/false: Track clicks on links.Default: false.
Google Analytics tagsgoogle_analyticstrue/false: Add Google Analytics tags to links.Default: false.

Outputs

campaignobject: The list the record belongs to
click_trackslist: Tracked links
contentobject: Body
created_ontext: When it was created
editortext: Editor used
flagslist: clicktrack, google_analytics
from_fieldobject: Sender
hreftext: API URL
nametext: Internal name
newsletter_idtext: Newsletter id
reply_toobject: Reply-to
send_metricsobject: Delivery numbers
send_ontext: When it is or was sent
send_settingsobject: Who it goes to and when
statustext: enabled or disabled
subjecttext: Subject line
typetext: draft or broadcast

Example output

{
  "campaign": {
    "campaign_id": "V",
    "href": "https://api.getresponse.com/v3/campaigns/V",
    "name": "newsletter_subscribers"
  },
  "content": {
    "html": "<p>Hello</p>",
    "plain": "Hello"
  },
  "created_on": "2026-03-02T07:30:49+0000",
  "editor": "custom",
  "flags": [
    "clicktrack"
  ],
  "from_field": {
    "from_field_id": "V"
  },
  "href": "https://api.getresponse.com/v3/newsletters/N3s",
  "name": "March update",
  "newsletter_id": "N3s",
  "send_metrics": {
    "click_rate": 7.1,
    "delivered": 118,
    "open_rate": 42.5,
    "sent": 120,
    "status": "finished",
    "total": 120
  },
  "send_on": "2026-03-14T07:00:00+0000",
  "send_settings": {
    "selected_campaigns": [
      "V"
    ],
    "time_travel": false
  },
  "status": "enabled",
  "subject": "What's new in March",
  "type": "draft"
}

Delete contact

Delete a contact. Give a message id to record it as an unsubscribe from that message instead, as if they clicked its unsubscribe link.

Inputs

Contact IDcontact_idtextRequired: The contact's id, from List contacts or an earlier step. The contact's API URL (ending in the id) also works.
Unsubscribed from messagemessage_idtext: Optional newsletter id: records the removal as an unsubscribe from that message.
Unsubscribe IP addressip_addresstext: The IP the unsubscribe came from. Needs a message id.

Outputs

contact_idtext: Contact id
deletedtrue/false: Always true

Example output

{
  "contact_id": "pV3r",
  "deleted": true
}

Get account

Read the GetResponse account the API key belongs to: its login email, name, company, address, country and time zone.

Inputs

None.

Outputs

account_idtext: Account id
citytext: City
company_nametext: Company name
country_codeobject: Country
emailtext: The account's login email
first_nametext: First name
hreftext: API URL of the account
industry_tagobject: Industry
last_nametext: Last name
number_of_employeestext: Company size: 50, 250, 500 or more
phonetext: Phone number
statetext: State or region
streettext: Street address
time_formattext: 12h or 24h
time_zoneobject: The account's time zone
zip_codetext: Postal code

Example output

{
  "account_id": "Ab3",
  "company_name": "Example Ltd",
  "email": "owner@example.com",
  "first_name": "Jane",
  "href": "https://api.getresponse.com/v3/accounts",
  "last_name": "Doe",
  "time_format": "24h",
  "time_zone": {
    "name": "Europe/Warsaw",
    "offset": "+01:00"
  }
}

Get contact

Read one contact with its list, custom field values, tags and sign-up location.

Inputs

Contact IDcontact_idtextRequired: The contact's id, from List contacts or an earlier step. The contact's API URL (ending in the id) also works.

Outputs

activitiestext: API URL of the contact's activities
campaignobject: The list the record belongs to
changed_ontext: When the contact last changed
contact_idtext: Contact id
created_ontext: When the contact was added
custom_field_valueslist: Custom field values
day_of_cycletext: Autoresponder cycle day, if on one
emailtext: Email address
engagement_scorenumber: Engagement score, 1-5
geolocationobject: Where the contact signed up from
hreftext: API URL of the contact
ip_addresstext: Sign-up IP address
nametext: Name
notetext: Note
origintext: How the contact was added, such as api or import
scoringnumber: Contact score (Marketer plan and up)
tagslist: Tags on the contact
time_zonetext: The contact's time zone

Example output

{
  "activities": "https://api.getresponse.com/v3/contacts/pV3r/activities",
  "campaign": {
    "campaign_id": "V",
    "href": "https://api.getresponse.com/v3/campaigns/V",
    "name": "newsletter_subscribers"
  },
  "changed_on": "2026-03-04T10:12:01+0000",
  "contact_id": "pV3r",
  "created_on": "2026-03-02T07:30:49+0000",
  "custom_field_values": [
    {
      "custom_field_id": "pas",
      "name": "favourite_colour",
      "type": "text",
      "value": [
        "blue"
      ],
      "value_type": "string",
      "values": [
        "blue"
      ]
    }
  ],
  "day_of_cycle": null,
  "email": "jane@example.com",
  "engagement_score": 3,
  "href": "https://api.getresponse.com/v3/contacts/pV3r",
  "ip_address": "1.2.3.4",
  "name": "Jane Doe",
  "note": null,
  "origin": "api",
  "tags": [],
  "time_zone": "Europe/Warsaw"
}

Get contact list

Read one contact list with its opt-in settings (single or double, per sign-up method), confirmation email, postal address and public profile.

Inputs

Listcampaign_idtextRequired: The contact list. Pick one, or use a list id from an earlier step.

Outputs

campaign_idtext: List id
confirmationobject: Confirmation email settings
created_ontext: When the list was created
descriptiontext: Same as the name; kept by GetResponse for compatibility
hreftext: API URL of the list
is_defaulttrue/false: Whether this is the account's default list
language_codetext: Two-letter language code
nametext: List name
optin_typesobject: Single or double opt-in, per sign-up method
postalobject: Postal address added to messages
profileobject: Public list profile
subscription_notificationsobject: Sign-up notification settings
tech_nametext: Internal list name

Example output

{
  "campaign_id": "V",
  "created_on": "2026-03-02T07:30:49+0000",
  "description": "newsletter_subscribers",
  "href": "https://api.getresponse.com/v3/campaigns/V",
  "is_default": true,
  "language_code": "EN",
  "name": "newsletter_subscribers",
  "optin_types": {
    "api": "single",
    "email": "double",
    "import": "single",
    "webform": "double"
  },
  "tech_name": "newsletter_subscribers"
}

Read one newsletter with its content, sender, tracked links, send settings and delivery numbers.

Inputs

Newsletter IDnewsletter_idtextRequired: The newsletter's id, from List newsletters or an earlier step.

Outputs

campaignobject: The list the record belongs to
click_trackslist: Tracked links
contentobject: Body
created_ontext: When it was created
editortext: Editor used
flagslist: clicktrack, google_analytics
from_fieldobject: Sender
hreftext: API URL
nametext: Internal name
newsletter_idtext: Newsletter id
reply_toobject: Reply-to
send_metricsobject: Delivery numbers
send_ontext: When it is or was sent
send_settingsobject: Who it goes to and when
statustext: enabled or disabled
subjecttext: Subject line
typetext: draft or broadcast

Example output

{
  "campaign": {
    "campaign_id": "V",
    "href": "https://api.getresponse.com/v3/campaigns/V",
    "name": "newsletter_subscribers"
  },
  "content": {
    "html": "<p>Hello</p>",
    "plain": "Hello"
  },
  "created_on": "2026-03-02T07:30:49+0000",
  "editor": "custom",
  "flags": [
    "clicktrack"
  ],
  "from_field": {
    "from_field_id": "V"
  },
  "href": "https://api.getresponse.com/v3/newsletters/N3s",
  "name": "March update",
  "newsletter_id": "N3s",
  "send_metrics": {
    "click_rate": 7.1,
    "delivered": 118,
    "open_rate": 42.5,
    "sent": 120,
    "status": "finished",
    "total": 120
  },
  "send_on": "2026-03-14T07:00:00+0000",
  "send_settings": {
    "selected_campaigns": [
      "V"
    ],
    "time_travel": false
  },
  "status": "enabled",
  "subject": "What's new in March",
  "type": "draft"
}

Read a newsletter's sends, opens, clicks, goals, forwards, unsubscribes, bounces and complaints, in total or by hour, day or month.

Inputs

Newsletter IDnewsletter_idtextRequired: The newsletter's id, from List newsletters or an earlier step.
Group bygroup_bytext: Totals, or one row per hour, day or month.One of: total, hour (By hour), day (By day), month (By month). Default: total.
Created on or aftercreated_fromdate: Only include records created on or after this date.
Created on or beforecreated_todate: Only include records created on or before this date.

Outputs

countnumber: How many rows
group_bytext: Grouping used
newsletter_idtext: Newsletter id
statisticslist: One row per period

Example output

{
  "count": 1,
  "group_by": "total",
  "newsletter_id": "N3s",
  "statistics": [
    {
      "bounced": 2,
      "complaints": 0,
      "sent": 120,
      "time_interval": "2026-03-14T00:00:00+0000/P0Y0M1DT0H0M0S",
      "total_clicked": 9,
      "total_opened": 61,
      "unique_clicked": 8,
      "unique_opened": 51,
      "unsubscribed": 1
    }
  ]
}

List contact activities

List a contact's sends, opens and clicks, newest first. Without dates, GetResponse returns the last 14 days.

Inputs

Contact IDcontact_idtextRequired: The contact's id, from List contacts or an earlier step. The contact's API URL (ending in the id) also works.
Created on or aftercreated_fromdate: Only include records created on or after this date.
Created on or beforecreated_todate: Only include records created on or before this date.
Results per pageper_pagenumber: How many records to return, 1-1000. Defaults to 100.From 1 to 1000. Default: 100.
Pagepagenumber: Which page to read, starting at 1. Use 'next_page' from a run.From 1 to 100000. Default: 1.

Outputs

activitieslist: Activities
contact_idtext: Contact id
countnumber: Records on this page
has_moretrue/false: Whether a page follows
next_pagenumber: The 'page' that reads the next page
pagenumber: The page returned
per_pagenumber: Page size used
total_countnumber: Records matching, across every page
total_pagesnumber: How many pages there are

Example output

{
  "activities": [
    {
      "activity": "open",
      "created_on": "2026-03-14T08:01:12+0000",
      "resource": {
        "resource_id": "N3s",
        "resource_type": "newsletters"
      },
      "subject": "What's new in March"
    }
  ],
  "contact_id": "pV3r",
  "count": 1,
  "has_more": false,
  "next_page": null,
  "page": 1,
  "per_page": 100,
  "total_count": 1,
  "total_pages": 1
}

List contact lists

List the account's contact lists (GetResponse's API calls them campaigns), with each list's id, name, language and whether it is the default.

Inputs

Name containsnametext: Only include lists whose name contains this text.
Sort bysort_bytext: Order the lists by this field.One of: name, createdOn (Date created).
Sort directionsort_directiontext: Ascending or descending. Defaults to descending.One of: ASC (Ascending), DESC (Descending).
Results per pageper_pagenumber: How many records to return, 1-1000. Defaults to 100.From 1 to 1000. Default: 100.
Pagepagenumber: Which page to read, starting at 1. Use 'next_page' from a run.From 1 to 100000. Default: 1.

Outputs

campaignslist: Contact lists
countnumber: Records on this page
has_moretrue/false: Whether a page follows
next_pagenumber: The 'page' that reads the next page
pagenumber: The page returned
per_pagenumber: Page size used
total_countnumber: Records matching, across every page
total_pagesnumber: How many pages there are

Example output

{
  "campaigns": [
    {
      "campaign_id": "V",
      "created_on": "2026-03-02T07:30:49+0000",
      "description": "newsletter_subscribers",
      "href": "https://api.getresponse.com/v3/campaigns/V",
      "is_default": true,
      "language_code": "EN",
      "name": "newsletter_subscribers",
      "tech_name": "newsletter_subscribers"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_page": null,
  "page": 1,
  "per_page": 100,
  "total_count": 1,
  "total_pages": 1
}

List contacts

Search contacts by email, name, list, origin or date added. A contact who has not yet confirmed a double opt-in email is not returned.

Inputs

Emailemailtext: Email address, or part of one.
Namenametext: Contact name, or part of one.
Listcampaign_idtext: Only include records on this contact list.
Originorigintext: Only include contacts added this way.One of: api, import, email, www (Web form), panel (Added in the app), leads, sale, survey, iphone (iPhone app), copy (Copied from another list), and 6 more.
Created on or aftercreated_fromdate: Only include records created on or after this date.
Created on or beforecreated_todate: Only include records created on or before this date.
Exact matchexact_matchtrue/false: Match the email and name exactly instead of matching any contact that contains them.Default: false.
Sort bysort_bytext: Order the contacts by this field.One of: createdOn (Date added), changedOn (Date last changed), email, name, campaignId (List).
Sort directionsort_directiontext: Ascending or descending. Defaults to descending.One of: ASC (Ascending), DESC (Descending).
Results per pageper_pagenumber: How many records to return, 1-1000. Defaults to 100.From 1 to 1000. Default: 100.
Pagepagenumber: Which page to read, starting at 1. Use 'next_page' from a run.From 1 to 100000. Default: 1.

Outputs

contactslist: Contacts
countnumber: Records on this page
has_moretrue/false: Whether a page follows
next_pagenumber: The 'page' that reads the next page
pagenumber: The page returned
per_pagenumber: Page size used
total_countnumber: Records matching, across every page
total_pagesnumber: How many pages there are

Example output

{
  "contacts": [
    {
      "activities": "https://api.getresponse.com/v3/contacts/pV3r/activities",
      "campaign": {
        "campaign_id": "V",
        "href": "https://api.getresponse.com/v3/campaigns/V",
        "name": "newsletter_subscribers"
      },
      "changed_on": "2026-03-04T10:12:01+0000",
      "contact_id": "pV3r",
      "created_on": "2026-03-02T07:30:49+0000",
      "day_of_cycle": null,
      "email": "jane@example.com",
      "engagement_score": 3,
      "href": "https://api.getresponse.com/v3/contacts/pV3r",
      "ip_address": "1.2.3.4",
      "name": "Jane Doe",
      "note": null,
      "origin": "api",
      "time_zone": "Europe/Warsaw"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_page": null,
  "page": 1,
  "per_page": 100,
  "total_count": 1,
  "total_pages": 1
}

List custom fields

List the account's custom fields with each one's type, format and, for choice fields, the values it allows.

Inputs

Name containsnametext: Only include fields whose name contains this.
Results per pageper_pagenumber: How many records to return, 1-1000. Defaults to 100.From 1 to 1000. Default: 100.
Pagepagenumber: Which page to read, starting at 1. Use 'next_page' from a run.From 1 to 100000. Default: 1.

Outputs

countnumber: Records on this page
custom_fieldslist: Custom fields
has_moretrue/false: Whether a page follows
next_pagenumber: The 'page' that reads the next page
pagenumber: The page returned
per_pagenumber: Page size used
total_countnumber: Records matching, across every page
total_pagesnumber: How many pages there are

Example output

{
  "count": 1,
  "custom_fields": [
    {
      "custom_field_id": "pas",
      "format": "text",
      "hidden": false,
      "href": "https://api.getresponse.com/v3/custom-fields/pas",
      "name": "favourite_colour",
      "type": "string",
      "value_type": "string",
      "values": []
    }
  ],
  "has_more": false,
  "next_page": null,
  "page": 1,
  "per_page": 100,
  "total_count": 1,
  "total_pages": 1
}

List from addresses

List the sender addresses newsletters can be sent from, with whether each is active and its domain's authentication status.

Inputs

Email containsemailtext: Only include addresses containing this.
Active onlyactive_onlytrue/false: Only include addresses that can be sent from.Default: false.
Results per pageper_pagenumber: How many records to return, 1-1000. Defaults to 100.From 1 to 1000. Default: 100.
Pagepagenumber: Which page to read, starting at 1. Use 'next_page' from a run.From 1 to 100000. Default: 1.

Outputs

countnumber: Records on this page
from_fieldslist: From addresses
has_moretrue/false: Whether a page follows
next_pagenumber: The 'page' that reads the next page
pagenumber: The page returned
per_pagenumber: Page size used
total_countnumber: Records matching, across every page
total_pagesnumber: How many pages there are

Example output

{
  "count": 1,
  "from_fields": [
    {
      "created_on": "2026-03-02T07:30:49+0000",
      "domain": {
        "has_dmarc_warning": false,
        "status": "confirmed"
      },
      "email": "news@example.com",
      "from_field_id": "V",
      "href": "https://api.getresponse.com/v3/from-fields/V",
      "is_active": true,
      "is_default": true,
      "name": "Example News",
      "rewritten_email": null
    }
  ],
  "has_more": false,
  "next_page": null,
  "page": 1,
  "per_page": 100,
  "total_count": 1,
  "total_pages": 1
}

List newsletters

List newsletters and drafts with their subject, list, send date and delivery numbers.

Inputs

Listcampaign_idtext: Only include records on this contact list.
Typenewsletter_typetext: Only include this kind of message.One of: draft, broadcast, splittest (A/B test), automation.
Statusstatustext: Only include enabled or disabled messages.One of: enabled, disabled.
Subject containssubjecttext: Only include messages whose subject contains this.
Created on or aftercreated_fromdate: Only include records created on or after this date.
Created on or beforecreated_todate: Only include records created on or before this date.
Sort bysort_bytext: Order the messages by this field.One of: createdOn (Date created), sendOn (Send date).
Sort directionsort_directiontext: Ascending or descending. Defaults to descending.One of: ASC (Ascending), DESC (Descending).
Results per pageper_pagenumber: How many records to return, 1-1000. Defaults to 100.From 1 to 1000. Default: 100.
Pagepagenumber: Which page to read, starting at 1. Use 'next_page' from a run.From 1 to 100000. Default: 1.

Outputs

countnumber: Records on this page
has_moretrue/false: Whether a page follows
newsletterslist: Newsletters
next_pagenumber: The 'page' that reads the next page
pagenumber: The page returned
per_pagenumber: Page size used
total_countnumber: Records matching, across every page
total_pagesnumber: How many pages there are

Example output

{
  "count": 1,
  "has_more": false,
  "newsletters": [
    {
      "campaign": {
        "campaign_id": "V",
        "href": "https://api.getresponse.com/v3/campaigns/V",
        "name": "newsletter_subscribers"
      },
      "created_on": "2026-03-02T07:30:49+0000",
      "editor": "custom",
      "flags": [
        "clicktrack"
      ],
      "href": "https://api.getresponse.com/v3/newsletters/N3s",
      "name": "March update",
      "newsletter_id": "N3s",
      "send_metrics": {
        "click_rate": 7.1,
        "delivered": 118,
        "open_rate": 42.5,
        "sent": 120,
        "status": "finished",
        "total": 120
      },
      "send_on": "2026-03-14T07:00:00+0000",
      "status": "enabled",
      "subject": "What's new in March",
      "type": "draft"
    }
  ],
  "next_page": null,
  "page": 1,
  "per_page": 100,
  "total_count": 1,
  "total_pages": 1
}

List time zones

List the time zones GetResponse can schedule a newsletter in, each with the GetResponse time-zone id, IANA name, UTC offset and country.

Inputs

Searchsearchtext: Only include zones whose name or country contains this.

Outputs

countnumber: How many
timezoneslist: Time zones

Example output

{
  "count": 1,
  "timezones": [
    {
      "country": "Poland",
      "name": "Europe/Warsaw",
      "offset": "+01:00",
      "timezone_id": 282
    }
  ]
}

Send a draft newsletter now, or schedule it. It goes to the draft's own list unless you choose others. This emails real people.

Inputs

Newsletter IDnewsletter_idtextRequired: The newsletter's id, from List newsletters or an earlier step.
Send to listsrecipient_campaign_idslist: The lists that receive the message. Defaults to the newsletter's own list.
Send atsend_atdate and time: Schedule the send for this date and time. Leave empty to send now.
Schedule time zonetime_zone_idtext: The time zone GetResponse records the schedule in. The send happens at the moment picked either way; defaults to UTC.

Outputs

campaignobject: The list the record belongs to
click_trackslist: Tracked links
contentobject: Body
created_ontext: When it was created
editortext: Editor used
flagslist: clicktrack, google_analytics
from_fieldobject: Sender
hreftext: API URL
nametext: Internal name
newsletter_idtext: Newsletter id
reply_toobject: Reply-to
send_metricsobject: Delivery numbers
send_ontext: When it is or was sent
send_settingsobject: Who it goes to and when
statustext: enabled or disabled
subjecttext: Subject line
typetext: draft or broadcast

Example output

{
  "campaign": {
    "campaign_id": "V",
    "href": "https://api.getresponse.com/v3/campaigns/V",
    "name": "newsletter_subscribers"
  },
  "content": {
    "html": "<p>Hello</p>",
    "plain": "Hello"
  },
  "created_on": "2026-03-02T07:30:49+0000",
  "editor": "custom",
  "flags": [
    "clicktrack"
  ],
  "from_field": {
    "from_field_id": "V"
  },
  "href": "https://api.getresponse.com/v3/newsletters/N3s",
  "name": "March update",
  "newsletter_id": "N3s",
  "send_metrics": {
    "click_rate": 7.1,
    "delivered": 118,
    "open_rate": 42.5,
    "sent": 120,
    "status": "finished",
    "total": 120
  },
  "send_on": "2026-03-14T07:00:00+0000",
  "send_settings": {
    "selected_campaigns": [
      "V"
    ],
    "time_travel": false
  },
  "status": "enabled",
  "subject": "What's new in March",
  "type": "broadcast"
}

Set contact custom field

Add or change one custom field's value on a contact. The contact's other custom fields are kept.

Inputs

Contact IDcontact_idtextRequired: The contact's id, from List contacts or an earlier step. The contact's API URL (ending in the id) also works.
Custom fieldcustom_field_idtextRequired: The custom field to set.
ValuesvalueslistRequired: The value to store. A multi-select field takes several; a dropdown or radio field only takes one of its own values.

Outputs

contact_idtext: Contact id
countnumber: How many fields
custom_fieldslist: The contact's custom fields now

Example output

{
  "contact_id": "pV3r",
  "count": 1,
  "custom_fields": [
    {
      "custom_field_id": "pas",
      "values": [
        "blue"
      ]
    }
  ]
}

Update contact

Change a contact's name, email, note or autoresponder day, or move them to another list. Custom fields and tags are left untouched; use Set contact custom field to change a field.

Inputs

Contact IDcontact_idtextRequired: The contact's id, from List contacts or an earlier step. The contact's API URL (ending in the id) also works.
Namenametext: New name. Leave empty to keep the current one.
Emailemailtext: New email address. Leave empty to keep it.
Move to listcampaign_idtext: Move the contact to this list.
Autoresponder dayday_of_cyclenumber: Start the contact on the list's autoresponder cycle at this day (0 is the first day). Leave empty to keep them off the cycle.From 0 to 10000.
Notenotetext: A note on the contact, up to 255 characters.
Consents to open trackingopen_tracking_consenttrue/false: Whether the contact agreed to have email opens tracked.

Outputs

activitiestext: API URL of the contact's activities
campaignobject: The list the record belongs to
changed_ontext: When the contact last changed
contact_idtext: Contact id
created_ontext: When the contact was added
custom_field_valueslist: Custom field values
day_of_cycletext: Autoresponder cycle day, if on one
emailtext: Email address
engagement_scorenumber: Engagement score, 1-5
geolocationobject: Where the contact signed up from
hreftext: API URL of the contact
ip_addresstext: Sign-up IP address
nametext: Name
notetext: Note
origintext: How the contact was added, such as api or import
scoringnumber: Contact score (Marketer plan and up)
tagslist: Tags on the contact
time_zonetext: The contact's time zone

Example output

{
  "activities": "https://api.getresponse.com/v3/contacts/pV3r/activities",
  "campaign": {
    "campaign_id": "V",
    "href": "https://api.getresponse.com/v3/campaigns/V",
    "name": "newsletter_subscribers"
  },
  "changed_on": "2026-03-04T10:12:01+0000",
  "contact_id": "pV3r",
  "created_on": "2026-03-02T07:30:49+0000",
  "custom_field_values": [
    {
      "custom_field_id": "pas",
      "name": "favourite_colour",
      "type": "text",
      "value": [
        "blue"
      ],
      "value_type": "string",
      "values": [
        "blue"
      ]
    }
  ],
  "day_of_cycle": null,
  "email": "jane@example.com",
  "engagement_score": 3,
  "href": "https://api.getresponse.com/v3/contacts/pV3r",
  "ip_address": "1.2.3.4",
  "name": "Jane Doe",
  "note": null,
  "origin": "api",
  "tags": [],
  "time_zone": "Europe/Warsaw"
}

ActionsCopy Anchor Link

Add contactCopy Anchor Link

Inputs

Outputs

Create contact listCopy Anchor Link

Inputs

Outputs

Create custom fieldCopy Anchor Link

Inputs

Outputs

Create newsletterCopy Anchor Link

Inputs

Outputs

Delete contactCopy Anchor Link

Inputs

Outputs

Get accountCopy Anchor Link

Inputs

Outputs

Get contactCopy Anchor Link

Inputs

Outputs

Get contact listCopy Anchor Link

Inputs

Outputs

Get newsletterCopy Anchor Link

Inputs

Outputs

Get newsletter statisticsCopy Anchor Link

Inputs

Outputs

List contact activitiesCopy Anchor Link

Inputs

Outputs

List contact listsCopy Anchor Link

Inputs

Outputs

List contactsCopy Anchor Link

Inputs

Outputs

List custom fieldsCopy Anchor Link

Inputs

Outputs

List from addressesCopy Anchor Link

Inputs

Outputs

List newslettersCopy Anchor Link

Inputs

Outputs

List time zonesCopy Anchor Link

Inputs

Outputs

Send newsletter draftCopy Anchor Link

Inputs

Outputs

Set contact custom fieldCopy Anchor Link

Inputs

Outputs

Update contactCopy Anchor Link

Inputs

Outputs

On this page

Actions

Add contact

Create contact list

Create custom field

Create newsletter

Delete contact

Get account

Get contact

Get contact list

Get newsletter

Get newsletter statistics

List contact activities

List contact lists

List contacts

List custom fields

List from addresses

List newsletters

List time zones

Send newsletter draft

Set contact custom field

Update contact