How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
GetResponse

GetResponse API v3

The complete GetResponse API v3 — a JSON REST API of 220 operations across 141 paths and 42 product areas, described by a provider-published OpenAPI 3.0.0. Authentication is an X-Auth-Token header carrying an API key prefixed with "api-key ", or OAuth 2.0 with a single "all" scope. Every response carries X-RateLimit-* headers; errors return a custom ErrorResponse envelope discriminated by a numeric code rather than by HTTP status.

Documentation Provider Profile APIs.io OpenAPI GitHub

GetResponse API v3 is one of 50 APIs that GetResponse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Email Marketing, Marketing Automation, Contacts, Campaigns, and Newsletters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 220 operations across 141 paths, organized into 49 resource areas, and defines 435 schemas. It is described by OpenAPI 3.0.0, at version 3.2026-07-28T07:58:55+00:00.

Requests are made against 3 base URLs: https://api.getresponse.com/v3, https://api3.getresponse360.com/v3, https://api3.getresponse360.pl/v3.

220 operations 141 paths 435 schemas 25 DELETE126 GET69 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.2026-07-28T07:58:55+00:00
Base URL
https://api.getresponse.com/v3
Authentication
API Key, OAuth 2.0
Contact
API Support - DevZone
Resource Areas
49

Authentication & Security 2

GetResponse API v3 declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Token (api-key). It supports OAuth 2.0 (oauth2) using the implicit, authorizationCode and clientCredentials flows, exposing 1 scope.

  • api-key — Header value must be prefixed with api-key

Paths & Operations 220

Across 141 paths, the API surfaces 220 operations — 25 DELETE, 126 GET, 69 POST. They span 49 resource areas, including Webinars, Contacts, Search Contacts, Transactional Emails Templates, Transactional Emails, From Fields, RSS Newsletters, Taxes, and 41 more. Each is listed below with its method, path, parameters, and response codes.

Webinars 2

Webinars API documentation

GET
/webinars/{webinarId}
Get a webinar by ID
getWebinarById 2 params → 200404400401429
GET
/webinars
Get a list of webinars
getWebinarList 10 params → 200400401429
Contacts 11

API documentation for contacts and their properties (e.g., tags, custom fields)

GET
/contacts/{contactId}/activities
Get a list of contact activities
getActivities 6 params → 200400401429
GET
/campaigns/{campaignId}/contacts
Get contacts from a single campaign
getContactsFromCampaign 11 params → 200400401429
POST
/contacts/{contactId}/custom-fields
Upsert the custom fields of a contact
upsertContactCustoms 1 param body → 200404400401429
POST
/contacts/{contactId}/tags
Upsert the tags of a contact
upsertTags 1 param body → 200404400401429
GET
/contacts/{contactId}
Get contact details by contact ID
getContactById 2 params → 200404400401429
POST
/contacts/{contactId}
Update contact details
updateContact 1 param body → 200404409400401429
DELETE
/contacts/{contactId}
Delete a contact by contact ID
deleteContact 3 params → 204404400401429
GET
/contacts
Get contact list
getContactList 17 params → 200400401429
POST
/contacts
Create a new contact
createContact body → 202409400401429
POST
/contacts/batch
Create multiple contacts at once
createBatchContacts body → 202409400401429
GET
/contacts/{contactId}/consents
Get contact's consent fields
getContactConsentsById 2 params → 200400401429
Search Contacts 8

Search Contacts API documentation API documentation

GET
/search-contacts/{searchContactId}
Get search contacts by contact ID.
getSearchContactsById 2 params → 200404400401429
POST
/search-contacts/{searchContactId}
Update search contacts
updateSearchContacts 1 param body → 200404409400401429
DELETE
/search-contacts/{searchContactId}
Delete search contacts
deleteSearchContacts 1 param → 204404400401429
GET
/search-contacts/{searchContactId}/contacts
Get contacts by search contacts ID
getContactsByIdSearchContacts 7 params → 200404400401429
POST
/search-contacts/{searchContactId}/custom-fields
Upsert custom fields by search contacts
upsertCustomFieldsBySearchContactId 1 param body → 202404400401429
GET
/search-contacts
Get a saved search contact list
getSearchContactsList 8 params → 200400401429
POST
/search-contacts
Create search contacts
newSearchContacts body → 201409400401429
POST
/search-contacts/contacts
Search contacts using conditions
getContactsFromSearchContactsConditions 6 params body → 200400401429
Transactional Emails Templates 5
GET
/transactional-emails/templates/{transactionalEmailTemplateId}
Get a single template by ID
getTransactionalEmailsTemplatesById 2 params → 200404400401429
POST
/transactional-emails/templates/{transactionalEmailTemplateId}
Update transactional email template
updateTransactionalEmailsTemplate 1 param body → 200404400401429
DELETE
/transactional-emails/templates/{transactionalEmailTemplateId}
Delete transactional email template
deleteTransactionalEmailsTemplate 1 param → 204404400401429
GET
/transactional-emails/templates
Get the list of transactional email templates
getTransactionalEmailsTemplatesList 6 params → 200400401429
POST
/transactional-emails/templates
Create transactional email template
createTransactionalEmailTemplate body → 201400401429
Transactional Emails 4

Transactional Emails API documentation

GET
/transactional-emails/{transactionalEmailId}
Get transactional email details by transactional email ID
getTransactionalEmailsById 2 params → 200404400401429
GET
/transactional-emails
Get the list of transactional emails
getTransactionalEmailsList 7 params → 200400401429
POST
/transactional-emails
Send transactional email
createTransactionalEmail body → 201400401429
GET
/transactional-emails/statistics
Get the overall statistics of transactional emails
getTransactionalEmailsStatistics 6 params → 200400401429
From Fields 5

From Fields API documentation

GET
/from-fields/{fromFieldId}
Get a single 'From' address by ID
getFromFieldById 2 params → 200404400401429
DELETE
/from-fields/{fromFieldId}
Delete 'From' address
deleteFromField 2 params → 204404400401429
POST
/from-fields/{fromFieldId}/default
Set a 'From' address as default
setFromFieldAsDefault 1 param → 200404400401429
GET
/from-fields
Get the list of 'From' addresses
getFromFieldList 8 params → 200400401429
POST
/from-fields
Create 'From' address
createFromField body → 201404400401429
RSS Newsletters 7

RSS Newsletters API documentation

GET
/rss-newsletters/{rssNewsletterId}
Get RSS newsletter by ID
getRssNewsletterById 2 params → 200404400401429
POST
/rss-newsletters/{rssNewsletterId}
Update RSS newsletter
updateRssNewsletter 1 param body → 200404400401429
DELETE
/rss-newsletters/{rssNewsletterId}
Delete RSS newsletter
deleteRssNewsletter 1 param → 204404400401429
GET
/rss-newsletters/{rssNewsletterId}/statistics
Get RSS newsletter statistics by ID
getSingleRssNewsletterStatisticsCollection 7 params → 200404400401429
GET
/rss-newsletters
Get the list of RSS newsletters
getRssNewslettersList 9 params → 200400401429
POST
/rss-newsletters
Create RSS newsletter
createRssNewsletter body → 201404400401429
GET
/rss-newsletters/statistics
The statistics for all RSS newsletters
getRssNewsletterStatisticsCollection 8 params → 200400401429
Taxes 5

Taxes API documentation

GET
/shops/{shopId}/taxes
Get a list of taxes
getTaxList 8 params → 200400401429
POST
/shops/{shopId}/taxes
Create tax
createTax 1 param body → 201400401429
GET
/shops/{shopId}/taxes/{taxId}
Get a single tax by ID
getTaxById 3 params → 200404400401429
POST
/shops/{shopId}/taxes/{taxId}
Update tax
updateTax 2 params body → 200400401429
DELETE
/shops/{shopId}/taxes/{taxId}
Delete tax by ID
deleteTax 2 params → 204404400401429
Custom Events 6

Custom Events API documentation

GET
/custom-events/{customEventId}
Get custom events by custom event ID
getCustomEventById 2 params → 200404400401429
POST
/custom-events/{customEventId}
Update custom event details
updateCustomEvent 1 param body → 200404400401429
DELETE
/custom-events/{customEventId}
Delete a custom event by custom event ID
deleteCustomEvent 1 param → 204404400401429
GET
/custom-events
Get a list of custom events
getCustomEventsList 6 params → 200400401429
POST
/custom-events
Create custom event
createCustomEvent body → 201400401429
POST
/custom-events/trigger
Trigger a custom event
triggerCustomEvent body → 201404400401429
Forms 3

Forms API documentation

GET
/forms/{formId}
Get form by ID
getForm 2 params → 200404400401429
GET
/forms/{formId}/variants
Get the list of form variants (A/B tests)
getFormVariantList 2 params → 200404400401429
GET
/forms
Get the list of forms.
getFormList 14 params → 200400401429
Legacy Landing Pages 2

Legacy Landing Pages description

GET
/landing-pages/{landingPageId}
Get single landing page by ID
getLandingPageById 2 params → 200404400401429
GET
/landing-pages
Get a list of landing pages
getLandingPageList 15 params → 200400401429
Imports 3

Imports API documentation

GET
/imports/{importId}
Get import details by ID.
getImportById 2 params → 200404400401429
GET
/imports
Get a list of imports.
getImportList 14 params → 200400401429
POST
/imports
Schedule a new contact import
createImport body → 201409400401429
Sms 1
GET
/statistics/sms/{smsId}
Get details for the SMS message statistics
getSmsStats 4 params → 200400401429
Predefined Fields 5

Predefined Fields API documentation

GET
/predefined-fields/{predefinedFieldId}
Get a predefined field by ID
getPredefinedFieldById 2 params → 200404400401429
POST
/predefined-fields/{predefinedFieldId}
Update a predefined field
updatePredefinedField 1 param body → 200404400401429
DELETE
/predefined-fields/{predefinedFieldId}
Delete a predefined field
deletePredefinedField 1 param → 204404400401429
GET
/predefined-fields
Get the predefined fields list
getPredefinedFieldList 6 params → 200400401429
POST
/predefined-fields
Create a predefined field
createPredefinedField body → 201409400401429
Categories 5

Categories API documentation

GET
/shops/{shopId}/categories
Get the shop categories list
getCategories 11 params → 200400401429
POST
/shops/{shopId}/categories
Create category
createCategory 1 param body → 201404400401429
GET
/shops/{shopId}/categories/{categoryId}
Get a single category by ID
getCategory 3 params → 200404400401429
POST
/shops/{shopId}/categories/{categoryId}
Update category
updateCategory 2 params body → 200404400401429
DELETE
/shops/{shopId}/categories/{categoryId}
Delete category
deleteCategory 2 params → 204404400401429
Suppressions 5

Suppressions API documentaion

GET
/suppressions/{suppressionId}
Get a suppression list by ID
getSuppressionById 1 param → 200404400401429
POST
/suppressions/{suppressionId}
Update a suppression list by ID
updateSuppression 1 param body → 200404409400401429
DELETE
/suppressions/{suppressionId}
Deletes a given suppression list by ID
deleteSuppression 1 param → 204404400401429
GET
/suppressions
Get suppression lists
getSuppressionsList 8 params → 200400401429
POST
/suppressions
Creates a new suppression list
createSuppression body → 201409400401429
Orders 5

Orders API documentation

GET
/shops/{shopId}/orders
Get the list of orders
getOrderList 10 params → 200400401429
POST
/shops/{shopId}/orders
Create order
createOrder 2 params body → 201404400401429
GET
/shops/{shopId}/orders/{orderId}
Get a single order by ID
getOrderById 3 params → 200404400401429
POST
/shops/{shopId}/orders/{orderId}
Update order
updateOrder 3 params body → 200400401429
DELETE
/shops/{shopId}/orders/{orderId}
Delete order
deleteOrder 2 params → 204404400401429
Products 7

Products API documentation

GET
/shops/{shopId}/products
Get a product list.
getProductList 16 params → 200404400401429
POST
/shops/{shopId}/products
Create product
createProduct 1 param body → 201404400401429
GET
/shops/{shopId}/products/{productId}
Get a single product by ID
getProductById 3 params → 200404400401429
POST
/shops/{shopId}/products/{productId}
Update product
updateProduct 2 params body → 200404400401429
DELETE
/shops/{shopId}/products/{productId}
Delete product
deleteProduct 2 params → 204404400401429
POST
/shops/{shopId}/products/{productId}/categories
Upsert product categories
upsertProductCategories 2 params body → 200404400401429
POST
/shops/{shopId}/products/{productId}/meta-fields
Upsert product meta fields
upsertMetaFields 2 params body → 200404400401429
Shops 5

Shops API documentation

GET
/shops/{shopId}
Get a single shop by ID
getShopById 2 params → 200404400401429
POST
/shops/{shopId}
Update shop
updateShop 1 param body → 200404400401429
DELETE
/shops/{shopId}
Delete shop
deleteShop 1 param → 204404400401429
GET
/shops
Get a list of shops
getShopList 6 params → 200400401429
POST
/shops
Create shop
createShop body → 201400401429
Forms and Popups 2

Forms and Popups API documentation

GET
/popups/{popupId}
Get a single form or popup by ID
getPopupDetails 2 params → 200404400401429
GET
/popups
Get the list of forms and popups
getPopupsList 15 params → 200400401429
Form and Popup 1
GET
/statistics/popups/{popupId}/performance
Get statistics for a single form or popup
getPopupGeneralPerformance 6 params → 200400401429
A/B tests 2

A/B tests API documentation

GET
/splittests/{splittestId}
Get a single A/B test.
getSplittest 2 params → 200404400401429
GET
/splittests
The list of A/B tests.
getSplittestList 10 params → 200400401429
Custom Reports 3

Custom Reports API documentation

GET
/custom-reports/{customReportId}
Get a single custom report by ID
getCustomReportDetails 3 params → 200404400401429
GET
/custom-reports
Get a list of custom reports
getCustomReportList 7 params → 200400401429
POST
/custom-reports
Create the custom report
createCustomReport body → 201404400401429
Carts 5

Carts API documentation

GET
/shops/{shopId}/carts
Get shop carts
getCarts 8 params → 200400401429
POST
/shops/{shopId}/carts
Create cart
createCart 1 param body → 201404400401429
GET
/shops/{shopId}/carts/{cartId}
Get cart by ID
getCart 3 params → 200404400401429
POST
/shops/{shopId}/carts/{cartId}
Update cart
updateCart 2 params body → 200404400401429
DELETE
/shops/{shopId}/carts/{cartId}
Delete cart
deleteCart 2 params → 204404400401429
File Library 8

File Library API documentation

GET
/file-library/files/{fileId}
Get file by ID
getFileById 2 params → 200404400401429
DELETE
/file-library/files/{fileId}
Delete file by file ID
deleteFile 1 param → 204404400401429
DELETE
/file-library/folders/{folderId}
Delete folder by folder ID
deleteFolder 1 param → 204404400401429
GET
/file-library/quota
Get storage space information
quota → 200400401429
GET
/file-library/files
Get the list of files
getFileList 10 params → 200400401429
POST
/file-library/files
Create a file
createFile body → 201400401429
GET
/file-library/folders
Get the list of folders
getFolderList 7 params → 200400401429
POST
/file-library/folders
Create a folder
createFolder body → 201409400401429
A/B tests - subject 6

A/B tests - subject API documentation

POST
/ab-tests/subject/{abTestId}/winner
Choose A/B test winner
postAbtestsSubjectByIdWinner 1 param body → 204404400401429
GET
/ab-tests/subject/{abTestId}
Get a single A/B test by ID
getAbTestSubjectById 2 params → 200404400401429
POST
/ab-tests/{abTestId}/cancel
Cancel A/B test
cancelAbTest 1 param → 202404409400401429
DELETE
/ab-tests/{abTestId}
Delete A/B test
deleteAbTest 1 param → 204404400401429
GET
/ab-tests/subject
The list of A/B tests
GetAbTestSubjectList 11 params → 200400401429
POST
/ab-tests/subject
Create a new A/B test
createSubjectAbTest body → 201404400401429
Click Tracks 2

Click tracking refers to the data collected about each link click, such as how many people clicked it, how many clicks resulted in desired actions such as sales, forwards or subsc…

GET
/click-tracks/{clickTrackId}
Get click tracked link details by click track ID
getClickTrackById 2 params → 200404400401429
GET
/click-tracks
Get click tracked links list
getClickTrackList 6 params → 200400401429
Newsletters 10

Newsletters API documentation

GET
/newsletters/{newsletterId}
Get a single newsletter by its ID.
getNewsletter 2 params → 200404400401429
DELETE
/newsletters/{newsletterId}
Delete newsletter
deleteNewsletter 1 param → 204404400401429
GET
/newsletters/{newsletterId}/activitiesdeprecated
Get newsletter activities
getNewsletterActivities 7 params → 200400401429
POST
/newsletters/{newsletterId}/cancel
Cancel sending the newsletter
cancelMessageSend 1 param → 200404400401429
GET
/newsletters/{newsletterId}/statistics
The statistics of single newsletter
getSingleNewsletterStatistics 7 params → 200404400401429
GET
/newsletters/{newsletterId}/thumbnail
Get newsletter thumbnail
getNewsletterThumbnail 2 params → 200404400401429
GET
/newsletters
Get the newsletter list
getNewsletterList 14 params → 200400401429
POST
/newsletters
Create newsletter
createNewsletter body → 201404400401429
POST
/newsletters/send-draft
Send the newsletter draft
sendDraft body → 201400401429
GET
/newsletters/statistics
Total newsletter statistics
getNewsletterStatisticsCollection 8 params → 200400401429
Tags 5

Tags API documentation

GET
/tags/{tagId}
Get tag by ID
getTagById 3 params → 200404400401429
POST
/tags/{tagId}deprecated
Update tag by ID
updateTag 1 param body → 200404400401429
DELETE
/tags/{tagId}
Delete tag by ID
deleteTag 1 param → 204404400401429
GET
/tags
Get the list of tags
getTagsList 8 params → 200400401429
POST
/tags
Add a new tag
createTag body → 201400401429
Addresses 5

Addresses API documentation

GET
/addresses/{addressId}
Get an address by ID
getAddress 2 params → 200404400401429
POST
/addresses/{addressId}
Update address
updateAddress 1 param body → 200404400401429
DELETE
/addresses/{addressId}
Delete address
deleteAddress 1 param → 204404400401429
GET
/addresses
Get a list of addresses
getAddressList 17 params → 200400401429
POST
/addresses
Create address
createAddress body → 201400401429
Campaigns (Lists) 13

Our API v3 uses the terminology from the previous version of GetResponse. Campaigns and lists are the same resource under a different name. For now, please refer to lists as campa…

GET
/campaigns/{campaignId}/blocklists
Returns campaign blocklist masks
getCampaignBlocklist 2 params → 200404400401429
POST
/campaigns/{campaignId}/blocklists
Updates campaign blocklist masks
updateCampaignBlocklist 2 params body → 200404400401429
GET
/campaigns/{campaignId}
Get a single campaign by the campaign ID
getCampaign 2 params → 200404400401429
POST
/campaigns/{campaignId}
Update a campaign
updateCampaign 1 param body → 200404409400401429
GET
/campaigns
Get a list of campaigns
getCampaignList 7 params → 200400401429
POST
/campaigns
Create a campaign
createCampaign body → 201409400401429
GET
/campaigns/statistics/origins
Get subscriber origin statistics
getCampaignStatisticsOrigins 4 params → 200400401429
GET
/campaigns/statistics/locations
Get subscriber location statistics
getCampaignStatisticsLocations 4 params → 200400401429
GET
/campaigns/statistics/list-size
Get campaign size statistics
getCampaignStatisticsListSize 4 params → 200400401429
GET
/campaigns/statistics/subscriptions
Get the number and origin of subscription statistics
getCampaignStatisticsSubscriptions 4 params → 200400401429
GET
/campaigns/statistics/removals
Get removal statistics
getCampaignStatisticsRemovals 4 params → 200400401429
GET
/campaigns/statistics/balance
Get balance statistics
getCampaignStatisticsBalance 4 params → 200400401429
GET
/campaigns/statistics/summary
Get the statistics summary for selected campaigns
getCampaignStatisticsSummary 1 param → 200400401429
Custom Fields 5

Custom Fields API documentation

GET
/custom-fields/{customFieldId}
Get a single custom field definition by the custom field ID
getCustomFieldById 2 params → 200404400401429
POST
/custom-fields/{customFieldId}
Update the custom field definition
updateCustomField 1 param body → 200404400401429
DELETE
/custom-fields/{customFieldId}
Delete a single custom field definition
deleteCustomField 1 param → 204404400401429
GET
/custom-fields
Get a list of custom fields
getCustomFieldList 5 params → 200400401429
POST
/custom-fields
Create a custom field
createCustomField body → 201400401429
Landing Pages 2
GET
/lps/{lpsId}
Get a single landing page by ID
getLpsById 2 params → 200404400401429
GET
/lps
Get the list of landing pages
getLpsList 13 params → 200400401429
Landing Page 1
GET
/statistics/lps/{lpsId}/performance
Get details for landing page statistics
getLpsGeneralPerformanceStats 7 params → 200400401429
Product Variants 5

Product Variants API documentation

GET
/shops/{shopId}/products/{productId}/variants
Get a list of product variants
getProductVariantList 12 params → 200404400401429
POST
/shops/{shopId}/products/{productId}/variants
Create product variant
createProductVariant 2 params body → 201404400401429
GET
/shops/{shopId}/products/{productId}/variants/{variantId}
Get a single product variant by ID
getProductVariantById 4 params → 200404400401429
POST
/shops/{shopId}/products/{productId}/variants/{variantId}
Update product variant
updateProductVariant 3 params body → 200404400401429
DELETE
/shops/{shopId}/products/{productId}/variants/{variantId}
Delete product variant
deleteProductVariant 3 params → 204404400401429
Meta Fields 5

Meta Fields API documentation

GET
/shops/{shopId}/meta-fields
Get the shop meta fields
getMetaFields 10 params → 200404400401429
POST
/shops/{shopId}/meta-fields
Create meta field
createMetaField 1 param body → 201404400401429
GET
/shops/{shopId}/meta-fields/{metaFieldId}
Get the meta field by ID
getMetaField 3 params → 200404400401429
POST
/shops/{shopId}/meta-fields/{metaFieldId}
Update meta field
updateMetaField 2 params body → 200404400401429
DELETE
/shops/{shopId}/meta-fields/{metaFieldId}
Delete meta field
deleteMetaField 2 params → 204404400401429
Legacy Forms 2

Legacy Forms API documentation

GET
/webforms/{webformId}
Get Legacy Form by ID.
getLegacyFormById 2 params → 200404400401429
GET
/webforms
Get Legacy Forms.
getLegacyFormList 8 params → 200400401429
GDPR Fields 2
GET
/gdpr-fields/{gdprFieldId}
Get GDPR Field details
getGDPRField 2 params → 200404400401429
GET
/gdpr-fields
Get the GDPR fields list
getGDPRFieldList 5 params → 200400401429
Workflows 3

Workflows API documentation

GET
/workflow/{workflowId}
Get workflow by ID
getWorkflow 2 params → 200404400401429
POST
/workflow/{workflowId}
Update workflow
updateWorkflow 1 param body → 200404400401429
GET
/workflow
Get workflows
getWorkflowList 3 params → 200400401429
SMS Automation Messages 2

SMS Automation Messages API documentation

GET
/sms-automation/{smsId}
Get a single automated SMS message by its ID.
getSmsAutomationById 2 params → 200404400401429
GET
/sms-automation
Get the list of automated SMS messages.
getSMSAutomationList 12 params → 200400401429
SMS Messages 4

SMS Messages API documentation

GET
/sms/{smsId}
Get a single SMS message by its ID
getSmsById 2 params → 200404400401429
GET
/sms
Get the list of SMS messages
getSMSList 15 params → 200400401429
POST
/sms
Send an SMS message
sendSms body → 201404400401429
GET
/sms/sender-names
Get a list of SMS sender names
getSmsSenderNameList 2 params → 200400401429
Autoresponders 8

Autoresponders API documentation

GET
/autoresponders/{autoresponderId}
Get a single autoresponder by its ID
getAutoresponder 2 params → 200404400401429
POST
/autoresponders/{autoresponderId}
Update autoresponder
updateAutoresponder 1 param body → 200404409400401429
DELETE
/autoresponders/{autoresponderId}
Delete autoresponder.
deleteAutoresponder 1 param → 204404400401429
GET
/autoresponders/{autoresponderId}/statistics
The statistics for a single autoresponder
getSingleAutoresponderStatistics 7 params → 200400401429
GET
/autoresponders/{autoresponderId}/thumbnail
Get the autoresponder thumbnail
getAutoresponderThumbnail 2 params → 200404400401429
GET
/autoresponders
Get the list of autoresponders.
getAutoresponderList 16 params → 200400401429
POST
/autoresponders
Create autoresponder
createAutoresponder body → 201409400401429
GET
/autoresponders/statistics
The statistics for all autoresponders
getAutoresponderStatisticsCollection 8 params → 200400401429
Websites 2

Websites API documentation

GET
/websites/{websiteId}
Get a single Website by ID
getWebsiteById 2 params → 200404400401429
GET
/websites
Get the list of websites
getWebsitesList 13 params → 200400401429
Website 1
GET
/statistics/wbe/{websiteId}/performance
Get details for website statistics
getWbeGeneralPerformanceStats 7 params → 200400401429
Ecommerce 2
GET
/statistics/ecommerce/revenue
Get the ecommerce revenue statistics
getRevenueStats 4 params → 200400401429
GET
/statistics/ecommerce/performance
Get the ecommerce general performance statistics
getGeneralPerformanceStats 4 params → 200400401429
Subscription Confirmations 2

Subscription Confirmations API documentation

GET
/subscription-confirmations/body/{languageCode}
Get collection of SUBSCRIPTION CONFIRMATIONS bodies
getSubscriptionConfirmationBodyList 2 params → 200400401429
GET
/subscription-confirmations/subject/{languageCode}
Get collection of SUBSCRIPTION CONFIRMATIONS subjects
getSubscriptionConfirmationSubjectList 2 params → 200400401429
Accounts 14

Accounts API documentation

GET
/accounts/blocklists
Returns account blocklist masks
getAccountBlocklist 1 param → 200400401429
POST
/accounts/blocklists
Update account blocklist
updateAccountBlocklist 1 param body → 200400401429
GET
/accounts
Account information
getAccount 1 param → 200400401429
POST
/accounts
Update account
updateAccount body → 200400401429
GET
/accounts/billing
Billing information
getAccountBilling 1 param → 200400401429
GET
/accounts/timezones
List of timezones
getTimezones 1 param → 200400401429
GET
/accounts/callbacks
Get callbacks configuration
getCallbacks → 200404400401429
POST
/accounts/callbacks
Enable or update callbacks configuration
updateCallbacks body → 200400401429
DELETE
/accounts/callbacks
Disable callbacks
disableCallbacks → 204400401429
GET
/accounts/industries
List of Industry Tags
getIndustries 3 params → 200400401429
GET
/accounts/login-history
History of logins
getAccountLoginHistory 3 params → 200400401429
GET
/accounts/badge
Current status of your GetResponse badge
getAccountBadge → 200400401429
POST
/accounts/badge
Turn on/off the GetResponse Badge
updateAccountBadge body → 200400401429
GET
/accounts/sending-limits
Send limits
getSendingLimits 1 param → 200400401429
Multimedia 2

Multimedia API documentation

GET
/multimedia
Get images list
getImageList 3 params → 200400401429
POST
/multimedia
Upload image
uploadImage body → 200400401429
Tracking 2

Tracking API documentation

GET
/tracking
Get Tracking JavaScript code snippets
getTracking → 200401429
GET
/tracking/facebook-pixels
Get the list of "Facebook Pixels"
getFacebookPixelList → 200401429

Schemas 435

The contract defines 435 schemas that model the data the API accepts and returns. The most detailed are Splittest (22 properties), CampaignSubscriptionStatisticsItem (18 properties), BaseProductVariant (17 properties), Order (17 properties). Each schema is shown below with its type and property counts.

CreateAndUpdate
object
2 properties
Shop
object
NewShop
object
3 required
BaseCategory
object
7 properties
Category
object
NewCategory
object
1 required
UpdateShop
object
ProductCategory
object
NewProductCategory
object
1 required
BaseMetaField
object
6 properties
MetaField
object
NewMetaField
object
3 required
Product
object
NewProduct
object
2 required
UpdateProduct
object
UpsertProductCategory
object
This method makes it possible to assign product categories, and to set a default product category. It doesn't remove or unassign product categories.
1 property 1 required
UpsertSingleProductCategory
object
2 properties 1 required
UpsertMetaField
object
This method assigns metafields. It doesn't unassign or delete them.
1 property 1 required
UpsertSingleMetaField
object
1 property 1 required
UpdateMetaField
object
BaseProductVariant
object
17 properties
ProductVariant
object
NewProductVariant
object
4 required
UpdateProductVariant
object
NewProductVariantImage
object
4 properties 2 required
BaseTax
object
4 properties
Tax
object
NewTax
object
2 required
UpdateTax
object
Address
object
NewAddress
object
2 required
UpdateAddress
object
Order
object
17 properties
OrderResponse
object
NewOrder
object
4 required
UpdateOrder
object
NewSelectedProductVariant
object
6 properties 3 required
OrderSelectedProductVariant
object
3 required
NewCartSelectedProductVariant
object
5 properties 4 required
Cart
object
NewCart
object
4 required
UpdateCart
object
Webinar
object
10 properties
WebinarStatistics
object
3 properties 3 required
WebinarNewsletter
object
2 properties 2 required
ContactCustomField
object
2 properties
ContactActivity
object
6 properties
ContactActivityClickTrack
object
3 properties
ContactActivityResource
object
3 properties
ContactConsentHistoryItem
object
4 properties
ContactConsent
object
5 properties
ContactCustomFieldList
array
ContactListElement
ContactDetails
object
ContactCustomFieldValue
object
7 properties 5 required
ContactGeolocation
object
8 properties
BaseSearchContacts
object
The short description of a saved search.
4 properties
BaseSearchContactsDetails
object
1 required
SearchContactsDetails
object
Search contact details.
4 required
SearchContactsConditionsDetails
object
2 properties 2 required
NewSearchContacts
object
New search contacts.
3 required
UpdateSearchContacts
object
New search contacts.
3 required
SearchContactsBySearchForm
object
3 required
SubscribersTypeEnumForSegments
object
1 property
SubscribersTypeEnumForSearching
object
1 property
SpecificDateEnum
string
The specific date.
SpecificDateExtendedEnum
string
The specific date.
RelationalNumericOperatorEnum
string
The relational operators.
MessageTypeOperator
string
The type of message.
SearchedContactDetails
object
10 properties
SpecificDateType
string
The date formatted as yyyy-mm-dd
SpecificDateTimeType
string
The date time string compliant with ISO 8601
IntervalDateType
string
The date interval string compliant with ISO 8601, supported format: /
ConditionStringOperator
object
3 properties 3 required
ConditionMessageOperator
object
The operator allows searching by message type.
3 properties 3 required
CustomDateRange
object
2 properties 2 required
SectionAllTimeSubscriptionDate
object
SectionTodaySubscriptionDate
object
SectionYesterdaySubscriptionDate
object
SectionLast7DaysSubscriptionDate
object
SectionLast30DaysSubscriptionDate
object
SectionThisWeekSubscriptionDate
object
SectionLastWeekSubscriptionDate
object
SectionThisMonthSubscriptionDate
object
SectionLastMonthSubscriptionDate
object
SectionLast2MonthsSubscriptionDate
object
SectionCustomSubscriptionDate
object
1 required
SearchContactSection
object
5 properties 4 required
ConditionType
object
1 property 1 required
NameCondition
object
EmailCondition
object
CustomFieldCondition
object
Search a contact by custom fields.
3 required
CustomFieldStringOperatorEnum
string
Allowed operators for "operatorType":"stringoperator" and "operatorType":"stringoperatorlist"
CustomFieldNumericOperatorEnum
string
Allowed operators for "operatorType":"numericoperator"
CustomFieldDateOperatorEnum
string
Allowed operators for "operatorType":"dateoperator"
CustomFieldValueForStringOperatorTypes
string
Any string, allowed only for "operatorType":"stringoperator" and "operatorType":"stringoperatorlist"
CustomFieldValueForNumericOperatorType
string
Any number, allowed only for "operatorType":"numericoperator"
CustomFieldValueForOperatorTypeDateAndOperatorSpecificDate
string
Allowed values for "operatorType":"dateoperator" with "operator":"specificdate"
CustomFieldValueDateForOperatorTypeDateAndOperatorDateToOrDateFrom
Date string formatted as yyyy-mm-dd, allowed only for "operatorType":"dateoperator" with "operator":"dateto" or "operator":"datefrom"
CustomFieldValueDateTimeForOperatorTypeDateAndOperatorDateToOrDateFrom
Date time string compliant with ISO 8601, allowed only for "operatorType":"dateoperator" with "operator":"dateto" or "operator":"datefrom"
CustomFieldValueForOperatorTypeDateAndOperatorCustom
Date interval string compliant with ISO 8601, supported format: / , allowed only for "operatorType":"dateoperator" with "operator":"custom"
SubscriptionDateCondition
object
Use this to find a contact by subscription date, use.
3 required
SubscriptionMethodCondition
object
The subscription method.
1 required
OpenedCondition
object
Search contacts who did open a message.
NotOpenedCondition
object
Search contacts who didn't open a message.
3 required
AutoresponderDayCondition
object
To find the autoresponder cycle day of a contact.
2 required
LastSendDateCondition
object
Search the last time when an email message was sent to a contact.
3 required
LastClickDateCondition
object
This is used to find the last time when a contact clicked a message.
3 required
LastOpenDateCondition
object
Search the last time when a contact opened a message.
3 required
WebinarCondition
object
Search contacts that have participated/not participated in a specific webinar as a host/listener/presenter/registrant/any user.
3 required
LinkClickedCondition
object
Search contacts that clicked on a link.
4 required
LinkNotClickedCondition
object
Search contacts that didn't click a link.
3 required
MessageSentCondition
object
Search contacts who received a certain message.
3 required
MessageNotSentCondition
object
Search contacts who didn't receive a certain message.
3 required
ECommerceBrandPurchasedCondition
object
Search contacts by brand purchased.
4 required
ECommerceProductPurchasedCondition
object
Search the product purchased.
6 required
ECommerceTotalSpentCondition
object
Search contacts by total spent.
6 required
ECommerceNumberOfPurchasesCondition
object
Search contacts by the number of purchases.
5 required
TagCondition
object
Search contacts by tag.
3 required
ECommerceAbandonedCartCondition
object
Search contacts by abandoned cart.
3 required
SmsSentCondition
object
Find contacts who were sent an SMS
1 required
SmsLinkClickedCondition
object
Find contacts who clicked a link from an SMS
2 required
SmsLinkNotClickedCondition
object
Find contacts who didn't click a link from an SMS
2 required
ScoringCondition
object
Search contacts by scoring.
1 required
EngagementScoreCondition
object
Search contacts by their engagement score
2 required
GeolocationCondition
object
Search contacts by geolocation.
4 required
GdprCondition
object
Find contacts based on whether they have given or not given specific consents.
2 required
CrmCondition
object
This makes it possible to search contacts by CRM conditions.
2 required
GoalCondition
object
Search contacts by a defined goal.
3 required
CustomEventCondition
object
Search contacts for which an custom event occurred / not occurred
3 required
CreateTransactionalEmail
object
5 properties 3 required
DirectContent
object
TemplateContent
object
NewTransactionalEmailTag
object
1 property 1 required
TransactionalEmailContent
object
3 properties 1 required
TransactionalEmailTemplate
object
The template content
2 properties 1 required
TransactionalEmailRecipients
object
A field containing the message recipients. You can enter up to 8 recipients.
3 properties 1 required
TransactionalEmailRecipientTo
object
1 required
TransactionalEmailRecipient
object
3 properties 1 required
TransactionalEmailAttachment
object
3 properties 3 required
TransactionalEmailsTemplateDetails
object
TransactionalEmailsTemplateListElement
object
6 properties
CreateTransactionalEmailTemplate
object
2 properties 1 required
TransactionalEmailTemplateContent
object
The template content. At least one field is required
2 properties
TransactionalEmailRecipientStatuses
object
TransactionalEmailRecipientClickedLink
object
2 properties
TransactionalEmailRecipientDetails
object
TransactionalEmailRecipientsDetails
object
3 properties 1 required
TransactionalEmailDetails
object
4 required
TransactionalEmailTag
object
1 property 1 required
TransactionalEmailRecipientSentOnStatus
object
1 property
TransactionalEmailListElement
object
6 properties 4 required
TransactionalEmailStatistics
object
6 properties
TransactionalEmail
object
1 property
FromFieldReference
object
2 properties 1 required
FromField
object
9 properties
NewFromField
object
2 properties 2 required
RssNewsletterDetails
object
RssNewsletterListItem
object
RssNewsletterSendSettingsListing
object
8 properties 2 required
RssNewsletterListSendAsapSettings
object
RssNewsletterListSendDailySettings
object
1 required
RssNewsletterListSendWeeklySettings
object
2 required
RssNewsletterListSendMonthlySettings
object
2 required
RssNewsletterListing
object
12 properties 2 required
MessageSendSettingSelectedCampaigns
array
A one-element array containing the Campaign ID to filter subscribers. Any additional elements in the array will be ignored.
MessageSendSettingSelectedSegments
array
The list of segment IDs to choose subscribers from.
MessageSendSettingSelectedSuppressions
array
The list of suppression IDs to exclude subscribers.
MessageSendSettingExcludedCampaigns
array
The list of campaign IDs to exclude subscribers.
MessageSendSettingExcludedSegments
array
The list of segment IDs to exclude subscribers.
MessageSendSettingSelectedContacts
array
The list of selected contacts.
BaseCampaign
object
7 properties
CampaignAdditionalProperties
object
5 properties
Campaign
object
1 required
NewCampaign
object
UpdateCampaign
object
CampaignConfirmation
object
7 properties
CampaignOptinTypes
object
4 properties
CampaignPostal
object
8 properties
CampaignProfile
object
5 properties
CampaignSubscriptionNotifications
object
2 properties
RssNewsletterSendSettingsDetails
object
9 properties 2 required
RssNewsletterSendAsapSettings
object
RssNewsletterSendDailySettings
object
1 required
RssNewsletterSendWeeklySettings
object
2 required
RssNewsletterSendMonthlySettings
object
2 required
RssNewsletter
object
12 properties 2 required
NewRssNewsletter
object
6 required
UpdateRssNewsletter
object
MessageFlagsArray
array
The message flags.
MessageFlagsString
string
Comma-separated list of message flags. The possible values are: openrate, clicktrack, and googleanalytics.
MessageEditorEnum
string
Indicates how the message was created: custom means a custom-made message, text means plain text content, getresponse means that the message was created using…
NewMessageEditorEnumOutput
string
How the message was created: editorv3 - created by GetResponse editor, text means plain text content, html means custom HTML content, getresponse is a deprecat…
MessageContent
object
The message content.
2 properties
Contact
object
13 properties 3 required
NewContactCustomFieldValue
object
2 properties 2 required
NewContactTag
object
1 property 1 required
ContactTag
object
4 properties
NewContactTags
object
1 property
NewContactCustomFieldValues
object
1 property
NewContact
object
2 required
UpsertContactCustomFields
object
1 required
UpsertContactTags
object
1 required
UpdateContact
object
NewSuppression
object
1 required
UpdateSuppression
object
2 required
NewPredefinedField
object
3 required
UpdatePredefinedField
object
1 property 1 required
UpdateCallbacks
object
2 properties
TriggerCustomEvent
object
3 properties 2 required
TriggerCustomEventAttribute
object
2 properties 2 required
TriggerCustomEventAttributeValue
The value of the attribute. Value type depends on the attribute definition
NewCustomEvent
object
UpdateCustomEvent
object
CustomEvent
object
2 properties 2 required
CustomEventDetails
object
2 required
CustomEventAttributeDetails
object
1 required
CustomEventAttribute
object
2 properties 2 required
FormVariant
object
6 properties
FormVariantDetails
object
11 properties
FormDetails
object
FormSettings
object
10 properties
Form
object
10 properties
FormStatistics
object
4 properties
BaseLandingPage
object
13 properties
LandingPageVariant
object
6 properties
LandingPage
object
NewImport
object
3 properties 3 required
NewImportContact
array
Import
object
8 properties
ImportStatistics
object
4 properties 4 required
ImportErrorStatistics
object
6 properties
SmsStats
object
10 properties 1 required
RevenueStatistics
object
2 properties
GeneralPerformanceStats
object
3 properties
PredefinedField
object
5 properties
PredefinedFieldDetails
object
The predefined field details.
Suppression
object
4 properties 1 required
BaseSuppression
object
2 properties
SuppressionDetails
object
SubscriptionConfirmationBody
object
4 properties
SubscriptionConfirmationSubject
object
3 properties
ShopDetails
object
PopupGeneralPerformanceStats
object
5 properties 1 required
PopupDetails
object
8 properties
PopupListItem
object
8 properties
PopupListItemStatistics
object
4 properties
SplittestNewsletter
object
11 properties
Splittest
object
22 properties
CustomReportFileStatusesEnum
string
CustomReportDaysOfWeekEnum
string
CustomReportFilterActivityType
object
1 property 1 required
CustomReportFilterMessageId
object
1 property 1 required
CustomReportTypesEnum
string
CustomReportFrequenciesEnum
string
MessageActivityReportActivityTypesEnum
string
BaseCreateCustomReport
object
3 properties 3 required
CreateSubscriptionRejectionsReport
object
CreateMessageStatsReport
object
CreateUnsubscribeContactsListsReport
object
CreateStandardSubscriberActivityReport
object
CreateBouncesReport
object
CreateAccountSummaryReport
object
CreateUserActivityReport
object
CreateListSummaryReport
object
CreateISPMessageStatsReport
object
CreateWebinarParticipantsReport
object
CreateImportErrorReport
object
CreateMessageClicksReport
object
CreateUnconfirmedContactsStatsReport
object
CreateTransactionalEmailBounceReport
object
CreateMessageActivityReport
object
CreateMessageActivityReportFilters
object
1 property 1 required
CustomReportDetails
object
8 properties
CustomReportScheduling
object
1 property
DailyReportScheduling
object
WeeklyReportScheduling
object
MonthlyReportScheduling
object
RecurringScheduling
object
2 properties
OneTimeReportScheduling
object
OneTimeScheduling
object
2 properties
SubscriptionRejectionsReportDetails
object
MessageStatsReportDetails
object
UnsubscribeContactsListsReportDetails
object
StandardSubscriberActivityReportDetails
object
BouncesReportDetails
object
AccountSummaryReportDetails
object
UserActivityReportDetails
object
ListSummaryReportDetails
object
IspMessageStatsReportDetails
object
WebinarParticipantsReportDetails
object
ImportErrorReportDetails
object
MessageClicksReportDetails
object
UnconfirmedContactsStatsReportDetails
object
TransactionalEmailBounceReportDetails
object
MessageActivityReportDetails
object
MessageActivityReportFilters
object
1 property
EmptyReportFilters
object
1 property
CustomReport
object
6 properties
NewFile
object
4 required
BaseFile
object
3 properties
FileGroup
string
The file group
FolderShort
object
1 property 1 required
File
object
1 required
FileProperty
object
2 properties 2 required
Quota
object
2 properties
Folder
object
4 properties 1 required
NewFolder
object
1 property 1 required
ChooseWinnerAbtestsSubject
object
1 property 1 required
AbtestsSubjectListItem
object
AbtestsSubject
object
5 properties
AbtestsSubjectDetails
object
AbtestsSubjectStatistics
object
3 properties
NewAbtestsSubject
object
ClickTrackResource
object
6 properties
ClickTrackMessage
object
The source message reference for a click track
5 properties
MessageStatisticsListElement
object
16 properties
SendNewsletterDraft
object
2 properties 2 required
NewsletterAttachment
object
3 properties
ExternalLexpad
object
External Lexpad settings for the message, read more: [External Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad)
2 properties 1 required
TimeZone
object
1 property 1 required
NewsletterSendSettingsDetails
object
10 properties
Newsletter
object
15 properties 2 required
NewNewsletter
object
11 properties 5 required
NewsletterListElement
object
13 properties 2 required
NewsletterSendSettingsListing
object
2 properties
NewsletterDetails
object
ClickTrack
object
4 properties
NewsletterActivity
object
3 properties
NewsletterActivityContactReference
object
3 properties
BaseTag
object
2 properties
TagDetails
object
Tag
object
NewTag
object
1 required
UpdateTag
object
1 required
Blocklist
object
1 property
UpdateBlocklist
object
1 required
UpdateCustomField
object
2 properties 2 required
CustomFieldTypeEnum
string
CustomFieldFormatEnum
string
CustomField
object
9 properties
CustomFieldResponse
object
9 properties
NewCustomField
object
5 required
CustomFieldReference
object
3 properties
Lps
object
LpsListItem
object
9 properties
LpsListItemStatistics
object
3 properties
LpsDetails
object
LpsDetailsStatistics
object
3 properties
LpsPage
object
6 properties
LpsStats
object
6 properties 1 required
ImageDetails
object
7 properties
CreateMultimedia
object
1 property
Tracking
object
3 properties
FacebookPixel
object
2 properties
StatusEnum
string
StringBooleanEnum
string
SortOrderEnum
string
DateOrDateTime
ErrorResponse
object
7 properties 7 required
SendingLimitsListItem
object
3 properties
UpdateAccount
object
Account
object
16 properties
IndustryTagId
object
1 property
IndustryTagProperties
object
2 properties
IndustryTag
object
1 required
TimezoneName
object
1 property
TimezoneOffset
object
1 property
TimezoneId
object
1 property
TimezoneCountry
object
1 property
Timezone
1 required
AccountsLoginHistoryListElement
object
4 properties
CallbackActions
object
5 properties
Callback
object
2 properties
AccountDetailsCountryCode
object
2 properties
AccountBadgeDetails
object
1 property
AccountBilling
object
10 properties
SubscriptionsByDatesStatisticsList
array
CampaignSubscriptionStatisticsList
object
Dates in the YYYY-MM-DD format are used as keys.
CampaignRemovalsStatisticsItem
object
CampaignSubscriptionStatisticsItemByCampaign
object
The properties of the result are indexed with the campaign ID.
CampaignSubscriptionStatisticsItem
object
18 properties
CampaignSummaryList
array
CampaignLocationsList
array
RemovalsByDatesStatisticsList
array
CampaignRemovalsStatisticsList
object
CampaignLocationItem
object
CampaignOriginsList
array
CampaignListSizesStatisticsElement
object
4 properties
CampaignListSizesStatisticsList
array
BalanceByDatesStatisticsList
array
CampaignBalanceStatisticsList
object
CampaignSummaryItem
object
The properties of the result are indexed with the location name (PL, EN, etc.).
CampaignListElement
object
CampaignReference
object
3 properties 1 required
CampaignStatisticsIdQuery
string
LegacyForm
object
8 properties
LegacyFormStatistics
object
2 properties
GDPRField
object
4 properties
GDPRFieldLatestVersion
object
3 properties
GDPRFieldDetails
object
UpdateWorkflow
object
1 property 1 required
Workflow
object
6 properties 4 required
WorkflowSubscriberStatistics
object
2 properties 2 required
SmsSenderNameStatusesEnum
string
BaseSendSms
object
3 properties 3 required
SendSmsToContacts
object
1 required
SendSmsToImportedNumbers
object
1 required
SmsSenderName
object
4 properties
SmsDetails
object
SmsAutomationListItem
object
9 properties 1 required
SmsAutomationDetails
object
SmsListItem
object
12 properties
UpdateAutoresponder
object
AutoresponderTriggerSettings
object
The conditions that will trigger the autoresponder
11 properties
AutoresponderSendSettingsType
string
When to send the message
AutoresponderSendSettingsTimeTravel
string
Should the message be sent in the user's or the subscriber's time zone
AutoresponderSendSettingsExcludedDaysOfWeek
array
The days of the week to exclude from message sending (the message will be sent on the next non-excluded day after the trigger)
AutoresponderSendSettingsDelayInHours
integer
How many hours to delay the message after a trigger occured, in the 0-23 format
AutoresponderSendSettingsSendAtHour
integer
The specific hour on which the message will be sent, in the 0-23 format
AutoresponderSendSettingsOutput
object
How the message will be delivered to the subscriber
6 properties
AutoresponderSendSettingsInput
object
How the message will be delivered to the subscriber
4 properties 1 required
AutoresponderSendSignupSettings
object
AutoresponderSendImmediatelySettings
object
AutoresponderSendDelaySettings
object
1 required
AutoresponderSendCustomSettings
object
1 required
Autoresponder
object
14 properties
NewAutoresponder
object
5 required
AutoresponderList
array
AutoresponderDetails
object
Website
object
10 properties
WebsiteStatistics
object
3 properties
WebsiteStats
object
6 properties 1 required
WebsiteDetails
object
WebsitePage
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

getresponse-open-api-original.json Raw ↑

Other APIs GetResponse publishes across the network.

GetResponse A/B tests API
AE Profile APIs.io
GetResponse A/B tests - subject API
AE Profile APIs.io
GetResponse Accounts API
AE Profile APIs.io
GetResponse Addresses API
AE Profile APIs.io
GetResponse Autoresponders API
AE Profile APIs.io
GetResponse Campaigns (Lists) API
AE Profile APIs.io
GetResponse Carts API
AE Profile APIs.io
GetResponse Categories API
AE Profile APIs.io
GetResponse Click Tracks API
AE Profile APIs.io
GetResponse Contacts API
AE Profile APIs.io
GetResponse Custom Events API
AE Profile APIs.io
GetResponse Custom Fields API
AE Profile APIs.io
#Email Marketing#Marketing Automation#Contacts#Campaigns#Newsletters#Autoresponders#E-Commerce#Transactional Email
← Back to G APIs
API Details
ID
getresponse:rest-api
Base URL
https://api.getresponse.com/v3
Docs
https://apireference.getresponse.com/
Provider
GetResponse
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=rest-api-2&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/rest-api-2"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of GetResponse API v3, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.