GetResponse Autoresponders API
Autoresponders API documentation
Autoresponders API documentation
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/getresponse-autoresponders-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: GetResponse APIv3 Autoresponders API
version: 3.2026-07-28T07:58:55+00:00
description: The Autoresponders operations of the GetResponse APIv3, split by tag from the provider-published OpenAPI at https://apireference.getresponse.com/open-api.json
contact:
name: API Support - DevZone
url: https://app.getresponse.com/feedback.html?devzone=yes
email: getresponse-devzone@cs.getresponse.com
servers:
- url: https://api.getresponse.com/v3
description: GetResponse
- url: https://api3.getresponse360.com/v3
description: GetResponse MAX US
- url: https://api3.getresponse360.pl/v3
description: GetResponse MAX PL
tags:
- name: Autoresponders
description: Autoresponders API documentation
paths:
/autoresponders/{autoresponderId}:
parameters:
- $ref: '#/components/parameters/autoresponderId'
get:
tags:
- Autoresponders
summary: Get a single autoresponder by its ID
operationId: getAutoresponder
parameters:
- $ref: '#/components/parameters/Fields'
responses:
'200':
$ref: '#/components/responses/AutoresponderDetails'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 404
code: 1013
codeDescription: The requested resource was not found
message: Resource not found
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013
context:
contactId: pVyRW
uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7
'400':
description: Request validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 400
code: 1000
codeDescription: General error of validation process, more details should be in context section
message: Validation error, see context section for more information
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000
context:
validationType: searchFilter[query]
fieldName: name
originalName: lorem-ipsum
errorDescription: Not allowed search field
uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa
'401':
description: Authentication error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 401
code: 1014
codeDescription: Problem during authentication process, check headers!
message: Unable to authenticate request. Check credentials or authentication method details
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014
context:
authenticationType: auth_token
uuid: 62417847-4f12-4c25-9b3a-0b619a187efe
'429':
description: The throttling limit has been reached
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 429
code: 1015
codeDescription: Too many request to API, quota reached, please wait till next quota window
message: You have reached your requests limit for this time window, please wait...
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015
context:
currentLimit: 30000
timeToReset: 100 seconds
uuid: 510c6726-7f65-46b7-a798-ca403133924f
security:
- api-key: []
- oauth2:
- all
post:
tags:
- Autoresponders
summary: Update autoresponder
description: '>
**The action-based autoresponder feature has been migrated over to marketing automation. Your existing autoresponders are
now converted into workflows. You can no longer create and update action-based autoresponders using our API.**
This method allows you to update an autoresponder. The same rules as in creating an autoresponder apply.
'
operationId: updateAutoresponder
requestBody:
$ref: '#/components/requestBodies/UpdateAutoresponder'
responses:
'200':
$ref: '#/components/responses/AutoresponderDetails'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 404
code: 1013
codeDescription: The requested resource was not found
message: Resource not found
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013
context:
contactId: pVyRW
uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 409
code: 1008
codeDescription: There is another resource with the same value of unique property
message: Property value is already taken
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008
context:
value: test-value
uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd
'400':
description: Request validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 400
code: 1000
codeDescription: General error of validation process, more details should be in context section
message: Validation error, see context section for more information
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000
context:
validationType: searchFilter[query]
fieldName: name
originalName: lorem-ipsum
errorDescription: Not allowed search field
uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa
'401':
description: Authentication error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 401
code: 1014
codeDescription: Problem during authentication process, check headers!
message: Unable to authenticate request. Check credentials or authentication method details
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014
context:
authenticationType: auth_token
uuid: 62417847-4f12-4c25-9b3a-0b619a187efe
'429':
description: The throttling limit has been reached
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 429
code: 1015
codeDescription: Too many request to API, quota reached, please wait till next quota window
message: You have reached your requests limit for this time window, please wait...
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015
context:
currentLimit: 30000
timeToReset: 100 seconds
uuid: 510c6726-7f65-46b7-a798-ca403133924f
security:
- api-key: []
- oauth2:
- all
delete:
tags:
- Autoresponders
summary: Delete autoresponder.
operationId: deleteAutoresponder
responses:
'204':
description: Delete autoresponder
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 404
code: 1013
codeDescription: The requested resource was not found
message: Resource not found
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013
context:
contactId: pVyRW
uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7
'400':
description: Request validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 400
code: 1000
codeDescription: General error of validation process, more details should be in context section
message: Validation error, see context section for more information
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000
context:
validationType: searchFilter[query]
fieldName: name
originalName: lorem-ipsum
errorDescription: Not allowed search field
uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa
'401':
description: Authentication error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 401
code: 1014
codeDescription: Problem during authentication process, check headers!
message: Unable to authenticate request. Check credentials or authentication method details
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014
context:
authenticationType: auth_token
uuid: 62417847-4f12-4c25-9b3a-0b619a187efe
'429':
description: The throttling limit has been reached
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 429
code: 1015
codeDescription: Too many request to API, quota reached, please wait till next quota window
message: You have reached your requests limit for this time window, please wait...
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015
context:
currentLimit: 30000
timeToReset: 100 seconds
uuid: 510c6726-7f65-46b7-a798-ca403133924f
security:
- api-key: []
- oauth2:
- all
/autoresponders/{autoresponderId}/statistics:
parameters:
- $ref: '#/components/parameters/autoresponderId'
get:
tags:
- Autoresponders
summary: The statistics for a single autoresponder
description: ">\nThis requst returns the statistics summary for a single given autoresponder. As in all statistics, you can change the date and time range (hourly daily monthly or total). Keep in mind\nthat all statistics date ranges are given in standard UTC period type objects. ([See ISO 8601 standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals))\n\n(https://app.getresponse.com/statistics.html?t=followup#total).\n You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by."
operationId: getSingleAutoresponderStatistics
parameters:
- name: query[groupBy]
in: query
description: Group results by time interval
required: false
schema:
type: string
enum:
- total
- hour
- day
- month
- name: query[createdOn][from]
in: query
description: Count data from this date
required: false
schema:
$ref: '#/components/schemas/DateOrDateTime'
- name: query[createdOn][to]
in: query
description: Count data to this date
required: false
schema:
$ref: '#/components/schemas/DateOrDateTime'
- $ref: '#/components/parameters/Fields'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Page'
responses:
'200':
$ref: '#/components/responses/SingleMessageStatisticsList'
'400':
description: Request validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 400
code: 1000
codeDescription: General error of validation process, more details should be in context section
message: Validation error, see context section for more information
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000
context:
validationType: searchFilter[query]
fieldName: name
originalName: lorem-ipsum
errorDescription: Not allowed search field
uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa
'401':
description: Authentication error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 401
code: 1014
codeDescription: Problem during authentication process, check headers!
message: Unable to authenticate request. Check credentials or authentication method details
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014
context:
authenticationType: auth_token
uuid: 62417847-4f12-4c25-9b3a-0b619a187efe
'429':
description: The throttling limit has been reached
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 429
code: 1015
codeDescription: Too many request to API, quota reached, please wait till next quota window
message: You have reached your requests limit for this time window, please wait...
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015
context:
currentLimit: 30000
timeToReset: 100 seconds
uuid: 510c6726-7f65-46b7-a798-ca403133924f
security:
- api-key: []
- oauth2:
- all
x-operation-class-name: GetAutoresponderStatistics
/autoresponders/{autoresponderId}/thumbnail:
parameters:
- $ref: '#/components/parameters/autoresponderId'
get:
tags:
- Autoresponders
summary: Get the autoresponder thumbnail
operationId: getAutoresponderThumbnail
parameters:
- name: size
in: query
description: The size of the autoresponder thumbnail
required: false
schema:
type: string
default: default
enum:
- default
- small
responses:
'200':
description: The autoresponder thumbnail.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
content:
image/*:
schema:
type: string
format: binary
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 404
code: 1013
codeDescription: The requested resource was not found
message: Resource not found
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013
context:
contactId: pVyRW
uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7
'400':
description: Request validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 400
code: 1000
codeDescription: General error of validation process, more details should be in context section
message: Validation error, see context section for more information
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000
context:
validationType: searchFilter[query]
fieldName: name
originalName: lorem-ipsum
errorDescription: Not allowed search field
uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa
'401':
description: Authentication error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 401
code: 1014
codeDescription: Problem during authentication process, check headers!
message: Unable to authenticate request. Check credentials or authentication method details
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014
context:
authenticationType: auth_token
uuid: 62417847-4f12-4c25-9b3a-0b619a187efe
'429':
description: The throttling limit has been reached
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 429
code: 1015
codeDescription: Too many request to API, quota reached, please wait till next quota window
message: You have reached your requests limit for this time window, please wait...
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015
context:
currentLimit: 30000
timeToReset: 100 seconds
uuid: 510c6726-7f65-46b7-a798-ca403133924f
security:
- api-key: []
- oauth2:
- all
x-type: get
x-operation-class-name: GetAutoresponderThumbnail
/autoresponders:
get:
tags:
- Autoresponders
summary: Get the list of autoresponders.
description: You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by.
operationId: getAutoresponderList
parameters:
- name: query[subject]
in: query
description: Search autoresponder by subject
required: false
schema:
type: string
- name: query[name]
in: query
description: Search autoresponder by name
required: false
schema:
type: string
- name: query[status]
in: query
description: Search autoresponder by status
required: false
schema:
type: string
enum:
- enabled
- disabled
- name: query[createdOn][from]
in: query
description: Search autoresponder created from this date
required: false
schema:
$ref: '#/components/schemas/DateOrDateTime'
- name: query[createdOn][to]
in: query
description: Search autoresponder created to this date
required: false
schema:
$ref: '#/components/schemas/DateOrDateTime'
- name: query[campaignId]
in: query
description: Search autoresponder by campaign ID
required: false
schema:
type: string
- name: sort[name]
in: query
description: Sort by name
required: false
schema:
$ref: '#/components/schemas/SortOrderEnum'
- name: sort[subject]
in: query
description: Sort by subject
required: false
schema:
$ref: '#/components/schemas/SortOrderEnum'
- name: sort[dayOfCycle]
in: query
description: Sort by cycle day
required: false
schema:
$ref: '#/components/schemas/SortOrderEnum'
- name: sort[delivered]
in: query
description: Sort by delivered
required: false
schema:
$ref: '#/components/schemas/SortOrderEnum'
- name: sort[openRate]
in: query
description: Sort by open rate
required: false
schema:
$ref: '#/components/schemas/SortOrderEnum'
- name: sort[clickRate]
in: query
description: Sort by click rate
required: false
schema:
$ref: '#/components/schemas/SortOrderEnum'
- name: sort[createdOn]
in: query
description: Sort by date
required: false
schema:
$ref: '#/components/schemas/SortOrderEnum'
- $ref: '#/components/parameters/Fields'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Page'
responses:
'200':
$ref: '#/components/responses/AutoresponderList'
'400':
description: Request validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 400
code: 1000
codeDescription: General error of validation process, more details should be in context section
message: Validation error, see context section for more information
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000
context:
validationType: searchFilter[query]
fieldName: name
originalName: lorem-ipsum
errorDescription: Not allowed search field
uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa
'401':
description: Authentication error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 401
code: 1014
codeDescription: Problem during authentication process, check headers!
message: Unable to authenticate request. Check credentials or authentication method details
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014
context:
authenticationType: auth_token
uuid: 62417847-4f12-4c25-9b3a-0b619a187efe
'429':
description: The throttling limit has been reached
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 429
code: 1015
codeDescription: Too many request to API, quota reached, please wait till next quota window
message: You have reached your requests limit for this time window, please wait...
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015
context:
currentLimit: 30000
timeToReset: 100 seconds
uuid: 510c6726-7f65-46b7-a798-ca403133924f
security:
- api-key: []
- oauth2:
- all
post:
tags:
- Autoresponders
summary: Create autoresponder
description: '>
**The action-based autoresponder feature has been migrated over to marketing automation. Your existing autoresponders are
now converted into workflows. You can no longer create and update action-based autoresponders using our API.**
This request allows you to create an autoresponder. Remember to select the proper `sendSettings` - depending on `type` you need to fill corresponding setting (eg. if you selected type `delay`, then you MUST fill `delayInHours` field).
'
operationId: createAutoresponder
requestBody:
$ref: '#/components/requestBodies/NewAutoresponder'
responses:
'201':
$ref: '#/components/responses/AutoresponderDetails'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 409
code: 1008
codeDescription: There is another resource with the same value of unique property
message: Property value is already taken
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008
context:
value: test-value
uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd
'400':
description: Request validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 400
code: 1000
codeDescription: General error of validation process, more details should be in context section
message: Validation error, see context section for more information
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000
context:
validationType: searchFilter[query]
fieldName: name
originalName: lorem-ipsum
errorDescription: Not allowed search field
uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa
'401':
description: Authentication error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 401
code: 1014
codeDescription: Problem during authentication process, check headers!
message: Unable to authenticate request. Check credentials or authentication method details
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014
context:
authenticationType: auth_token
uuid: 62417847-4f12-4c25-9b3a-0b619a187efe
'429':
description: The throttling limit has been reached
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
example:
value:
httpStatus: 429
code: 1015
codeDescription: Too many request to API, quota reached, please wait till next quota window
message: You have reached your requests limit for this time window, please wait...
moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015
context:
currentLimit: 30000
timeToReset: 100 seconds
uuid: 510c6726-7f65-46b7-a798-ca403133924f
security:
- api-key: []
- oauth2:
- all
/autoresponders/statistics:
get:
tags:
- Autoresponders
summary: The statistics for all autoresponders
description: ">\nThis returns the statistics summary for selected autoresponders. You can select them by specifying the autoresponder or campaign IDs.\nAs in all statistics, you can change the date and time range (hourly daily monthly or total). Keep in mind\nthat all statistics date ranges are given in standard UTC period type objects. ([See ISO 8601 standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals))\n\n(https://app.getresponse.com/statistics.html?t=followup#total).\n You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by."
operationId: getAutoresponderStatisticsCollection
parameters:
- name: query[groupBy]
in: query
description: Group results by time interval
required: false
schema:
type: string
enum:
- total
- hour
- day
- month
- name: query[autoreponderId]
in: query
description: The list of autoresponder resource IDs (string separated with '')
required: false
schema:
type: string
- name: query[campaignId]
in: query
description: The list of campaign resource IDs (string separated with '')
required: false
schema:
type: string
- name: query[createdOn][from]
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/getresponse/refs/heads/main/openapi/getresponse-autoresponders-api-openapi.yml