### 200 OK Response Sample for Get Import Details
Source: https://apireference.getresponse.com/
Example of a successful response when retrieving details for a specific import. Includes status, statistics, and timestamps.
```JSON
{
"importId": "o6gE",
"campaign":
{
"campaignId": "C",
"href": "https://api.getresponse.com/v3/campaigns/C",
"name": "Promo campaign"
},
"status": "uploaded",
"statistics":
{
"uploaded": 25,
"invalid": 5,
"updated": 10,
"addedToList": 10
},
"errorStatistics":
{
"syntaxErrors": 2,
"alreadyInQueue": 1,
"invalidDomains": 1,
"blacklist": 1,
"policyFailures": 1,
"mismatchedCriteria": 1
},
"createdOn": "2026-06-18T09:09:52+00:00",
"finishedOn": "2026-06-18T09:09:52+00:00",
"href": "https://api.getresponse.com/v3/imports/o6gE"
}
```
--------------------------------
### Example Authenticated Request with API Key
Source: https://apireference.getresponse.com/
This example shows how to make a cURL request to the GetResponse API using an API key for authentication.
```bash
$ curl -H "X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8" https://api.getresponse.com/v3/accounts
```
--------------------------------
### Client Credentials Token Response Example
Source: https://apireference.getresponse.com/
Example JSON response for a successful access token retrieval using the Client Credentials flow.
```json
{
"access_token": "e2222af2851a912470ec33c9b4de1ea3a304b7d7",
"expires_in": 86400,
"token_type": "Bearer",
"scope": null
}
```
--------------------------------
### 200 OK Response Sample for Get List of Imports
Source: https://apireference.getresponse.com/
Example of a successful response when retrieving a list of imports. Each import object contains similar details as a single import retrieval.
```JSON
[
{
"importId": "o6gE",
"campaign":
{
"campaignId": "C",
"href": "https://api.getresponse.com/v3/campaigns/C",
"name": "Promo campaign"
},
"status": "uploaded",
"statistics":
{
"uploaded": 25,
"invalid": 5,
"updated": 10,
"addedToList": 10
},
"errorStatistics":
{
"syntaxErrors": 2,
"alreadyInQueue": 1,
"invalidDomains": 1,
"blacklist": 1,
"policyFailures": 1,
"mismatchedCriteria": 1
},
"createdOn": "2026-06-18T09:09:52+00:00",
"finishedOn": "2026-06-18T09:09:52+00:00",
"href": "https://api.getresponse.com/v3/imports/o6gE"
}
]
```
--------------------------------
### Get Images List Response Sample
Source: https://apireference.getresponse.com/
This is a sample JSON response for the 'get /multimedia' endpoint, detailing a list of images with their properties.
```json
[
{
"imageId": "123456",
"originalImageUrl": "http://somesite.example.com/my_image.jpg",
"size": "1234567",
"name": "original_image",
"thumbnailUrl": "https://us-re.gr-cdn.com/114x/https://multimedia.getresponse.com/getresponse-hUXzv/photos/123456.jpg",
"url": "https://multimedia.getresponse.com/getresponse-hUXzv/photos/123456.jpg",
"extension": "jpg"
}
]
```
--------------------------------
### Example Authenticated Request (API Key)
Source: https://apireference.getresponse.com/open-api.json
This example demonstrates how to make an authenticated request to the GetResponse API using an API Key. It shows the required `X-Auth-Token` header.
```APIDOC
## GET /v3/accounts
### Description
Retrieves account information. This is an example endpoint to demonstrate authentication.
### Method
GET
### Endpoint
/v3/accounts
### Parameters
#### Headers
- **X-Auth-Token** (string) - Required - Your API key in the format 'api-key YOUR_API_KEY'.
### Request Example
```bash
curl -H "X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8" https://api.getresponse.com/v3/accounts
```
### Response
#### Success Response (200)
- **(structure depends on the actual account endpoint)** - Description of the account details returned.
#### Response Example
```json
{
"example": "Account details will be returned here"
}
```
```
--------------------------------
### 404 Not Found Error Example
Source: https://apireference.getresponse.com/open-api.json
Example of a resource not found error response. This occurs when the API cannot locate the requested resource.
```json
{
"httpStatus": 404,
"code": 1013,
"codeDescription": "The requested resource was not found",
"message": "Resource not found",
"moreInfo": "https:\/\/apidocs.getresponse.com\/en\/v3\/errors\/1013"
}
```
--------------------------------
### Access Token Response Example
Source: https://apireference.getresponse.com/
This is an example JSON response when successfully exchanging an authorization code for an access token.
```json
{
"access_token": "03807cb390319329bdf6c777d4dfae9c0d3b3c35",
"expires_in": 3600,
"token_type": "Bearer",
"scope": null,
"refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c"
}
```
--------------------------------
### Authorization Code Redirect Callback Example
Source: https://apireference.getresponse.com/
This is an example of the redirect URI after a resource owner grants access, including the authorization code and state parameter.
```url
https://myredirecturi.com/cb?code=ed17c498bfe343175cd7684c5b09979f2875b25c&state=xyz
```
--------------------------------
### List Folders Response Sample
Source: https://apireference.getresponse.com/
This is a sample JSON response when successfully listing folders. It includes folder ID, name, size, and creation date.
```json
[
{
"folderId": "t1G",
"name": "sample folder",
"size": 9564899,
"createdOn": "2019-10-14T17:17:13+0000"
}
]
```
--------------------------------
### Get Address by ID Response Sample
Source: https://apireference.getresponse.com/
Example response for retrieving a specific address by its ID. This details the structure of address information returned by the API.
```json
{
"addressId": "k9",
"href": "https://api.getresponse.com/v3/addresses/k9",
"countryCode": "POL",
"countryName": "Poland",
"name": "some_shipping_address",
"firstName": "John",
"lastName": "Doe",
"address1": "Arkonska 6",
"address2": "",
"city": "Gdansk",
"zip": "80-387",
"province": "pomorskie",
"provinceCode": "",
"phone": "1122334455",
"company": "GetResponse",
"createdOn": "2026-06-18T09:09:52+00:00",
"updatedOn": "2026-06-18T09:09:52+00:00"
}
```
--------------------------------
### Response Sample for List Landing Pages (200 OK)
Source: https://apireference.getresponse.com/
Example JSON response when a list of landing pages is successfully retrieved. Each object contains core details of a landing page.
```json
[
{
"landingPageId": "avYn",
"href": "https://api.getresponse.com/v3/landing-pages/avYn",
"metaTitle": "Some meta title",
"domain": "gr8.new",
"subdomain": "summer-sale",
"userDomain": "",
"userDomainPath": "",
"campaign":
{
"campaignId": "C",
"href": "https://api.getresponse.com/v3/campaigns/C",
"name": "Promo campaign"
},
"status": "enabled",
"userDomainStatus": "active",
"testAB": "true",
"createdOn": "2026-06-18T09:09:52+00:00",
"updatedOn": "2026-06-18T09:09:52+00:00"
}
]
```
--------------------------------
### Successful Response Sample (200 OK)
Source: https://apireference.getresponse.com/
Example of a successful response when retrieving a list of files.
```json
[
{
"fileId": "6rZ6",
"fileSize": 579644,
"group": "photo",
"thumbnail": "https://us-rs.gr-cdn.com/512x,sBIbGHAUIQfw7kTUjaD0fTzxfXPggsY_1WCWIKl3RAxE=/https://multimedia.getresponse.com/getresponse-ZJtEw/photos/05c53ab1-6119-4076-a96c-bbefa082ea1a.jpg",
"url": "https://multimedia.getresponse.com/getresponse-ZJtEw/photos/05c53ab1-6119-4076-a96c-bbefa082ea1a.jpg",
"properties": [
{
"name": "width",
"value": 1980
}
],
"createdOn": "2019-10-12T15:15:49+0000",
"href": "https://api.getresponse.com/v3/file-library/files/6pS",
"name": "image",
"extension": "jpg",
"folder": {
"folderId": "4a9f"
}
}
]
```
--------------------------------
### Create Product
Source: https://apireference.getresponse.com/
Create a new product.
```APIDOC
## POST /products
### Description
Create product.
### Method
POST
### Endpoint
/products
```
--------------------------------
### Get List of Webinars
Source: https://apireference.getresponse.com/
Retrieves a list of webinars, with options to filter by name, campaign ID, status, and type. Sorting can be applied by name, creation date, or start date. Pagination is supported.
```json
[
{
"webinarId": "yK6d",
"href": "https://api.getresponse.com/v3/webinars/yK6d",
"createdOn": "2026-06-18T09:09:52+00:00",
"startsOn": "2026-06-18T09:09:52+00:00",
"webinarUrl": "http://example.com",
"status": "upcoming",
"type": "all",
"campaigns": [
{
"campaignId": "C",
"href": "https://api.getresponse.com/v3/campaigns/C",
"name": "Promo campaign"
}
],
"newsletters": [
{
"newsletterId": "NuE4",
"href": "https://api.getresponse.com/v3/newsletters/NuE4"
}
],
"statistics": {
"registrants": 15,
"visitors": 10,
"attendees": 5
}
}
]
```
--------------------------------
### Error Response Examples
Source: https://apireference.getresponse.com/open-api.json
Examples of different error responses that can be returned by the GetResponse API.
```APIDOC
## Error Response Examples
### Description
This section provides examples of common error responses from the GetResponse API, covering validation, authentication, and rate limiting.
### Validation Error (400)
#### Response Example
```json
{
"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"
}
```
### Authentication Error (401)
#### Response Example
```json
{
"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"
}
```
### Rate Limiting Error (429)
#### Response Example
```json
{
"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 scopes)
```
--------------------------------
### Create Shop
Source: https://apireference.getresponse.com/
Create a new shop.
```APIDOC
## POST /shops
### Description
Create shop.
### Method
POST
### Endpoint
/shops
```
--------------------------------
### Error Response Example
Source: https://apireference.getresponse.com/open-api.json
Example of a throttling error response when the API request limit is reached.
```APIDOC
## Error Response (429)
### Description
The throttling limit has been reached.
### Response Example
```json
{
"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"
}
```
```
--------------------------------
### Response Sample for Single Landing Page (200 OK)
Source: https://apireference.getresponse.com/
Example JSON response when a single landing page is successfully retrieved. Includes details like meta information, variant data, and campaign association.
```json
[
{
"metaDescription": "Some meta description",
"metaNoindex": "yes",
"dayOfCycle": 2,
"optin": "single",
"favicoUrl": "https://my-landing-page.mohahaha.com/favico.ico",
"thankYouPageType": "stay_on_page",
"thankYouPageUrl": "https://my-landing-page.mohahaha.com/thank_you.html",
"url": "https://my-landing-page.mohahaha.com",
"variants":
[
{
"variantId": "PKxn",
"variant": "0",
"winner": true,
"visitors": "12",
"uniqueVisitors": "2",
"subscribed": "2"
}
],
"landingPageId": "avYn",
"href": "https://api.getresponse.com/v3/landing-pages/avYn",
"metaTitle": "Some meta title",
"domain": "gr8.new",
"subdomain": "summer-sale",
"userDomain": "",
"userDomainPath": "",
"campaign":
{
"campaignId": "C",
"href": "https://api.getresponse.com/v3/campaigns/C",
"name": "Promo campaign"
},
"status": "enabled",
"userDomainStatus": "active",
"testAB": "true",
"createdOn": "2026-06-18T09:09:52+00:00",
"updatedOn": "2026-06-18T09:09:52+00:00"
}
]
```
--------------------------------
### Get Sending Limits Response Sample
Source: https://apireference.getresponse.com/
This is a sample JSON response for the 'get /accounts/sending-limits' endpoint, showing sending limit details.
```json
[
{
"timeFrame": 2592000,
"limit": 2500,
"used": 0
}
]
```
--------------------------------
### 401 Unauthorized Error Example
Source: https://apireference.getresponse.com/open-api.json
Example of an error response when authentication fails. This typically occurs due to incorrect credentials or an invalid authentication method.
```json
{
"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"
}
```
--------------------------------
### NewShop Object
Source: https://apireference.getresponse.com/open-api.json
Used for creating a new shop. Requires name, locale, and currency.
```APIDOC
## NewShop Object
### Description
Used for creating a new shop. Requires name, locale, and currency.
### Required Properties
- **name** (string)
- **locale** (string)
- **currency** (string)
### Type
object
### AllOf
- #/components/schemas/Shop
```
--------------------------------
### Create Folder Request Sample
Source: https://apireference.getresponse.com/
This is a sample JSON payload for creating a new folder. It requires the folder name.
```json
{
"name": "sample folder"
}
```
--------------------------------
### API Key Authentication Example
Source: https://apireference.getresponse.com/
This snippet shows how to authenticate a request using an API Key by including the 'X-Auth-Token' header.
```APIDOC
## Authenticate with API Key
### Description
This endpoint demonstrates how to authenticate a request using an API Key. You need to include a custom `X-Auth-Token` header with your unique API key.
### Method
GET
### Endpoint
https://api.getresponse.com/v3/accounts
### Headers
- **X-Auth-Token** (string) - Required - Your API key, prefixed with `api-key `.
### Request Example
```bash
curl -H "X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8" https://api.getresponse.com/v3/accounts
```
```
--------------------------------
### Error Response Examples
Source: https://apireference.getresponse.com/open-api.json
Examples of different error responses that can be returned by the GetResponse API, including details on status codes, error codes, and descriptions.
```APIDOC
## Error Response Examples
### Description
This section provides examples of common error responses from the GetResponse API, illustrating the structure of error messages for different scenarios.
### Response Examples
#### Not Found (404)
```json
{
"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"
}
```
#### Conflict (409)
```json
{
"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"
}
```
#### Request Validation Error (400)
```json
{
"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"
}
```
#### Authentication Error (401)
```json
{
"httpStatus": 401,
"code": 1014,
"message": "Authentication error example"
}
```
```
--------------------------------
### Response Sample for List of Tags
Source: https://apireference.getresponse.com/
Provides an example of a successful response when retrieving a list of tags. Each tag object includes its ID, URL, creation date, name, and color.
```JSON
[
{
"tagId": "vBd5",
"href": "https://api.getresponse.com/v3/tags/vBd5",
"createdAt": "2020-11-20T08:00:00+0000",
"name": "My_Tag",
"color": "string"
}
]
```
--------------------------------
### Storage Space Information Response Sample (200 OK)
Source: https://apireference.getresponse.com/
Example of a JSON response containing storage space limit and current usage.
```JSON
{
"limit": 1048576,
"usage": 1024
}
```
--------------------------------
### Example Redirect with Authorization Code
Source: https://apireference.getresponse.com/open-api.json
This is an example of the redirect URL that GetResponse will use to send the authorization code back to your application after the user grants access.
```url
https://myredirecturi.com/cb?code=ed17c498bfe343175cd7684c5b09979f2875b25c&state=xyz
```
--------------------------------
### Sample JSON Response for Click Track Details
Source: https://apireference.getresponse.com/
Example of a successful JSON response when fetching details for a single click track.
```json
{
"clickTrackId": "C12t",
"name": "Click here",
"url": "https://example.com/shop",
"clicks": 25951,
"message":
{
"resourceId": "r35N",
"type": "broadcast",
"createdOn": "2019-12-01T08:21:28+0000",
"resourceType": "newsletters",
"href": "https://api.getresponse.com/v3/newsletters/r35N"
},
"href": "https://api.getresponse.com/v3/click-tracks/C12t"
}
```
--------------------------------
### GET /custom-reports/{reportId}
Source: https://apireference.getresponse.com/open-api.json
Retrieves details for a specific custom report. Use this endpoint to get comprehensive information about a single custom report by its ID.
```APIDOC
## GET /custom-reports/{reportId}
### Description
Retrieves details for a specific custom report. Use this endpoint to get comprehensive information about a single custom report by its ID.
### Method
GET
### Endpoint
/custom-reports/{reportId}
### Parameters
#### Path Parameters
- **reportId** (string) - Required - The unique identifier of the custom report.
### Headers
- **X-RateLimit-Limit** (integer) - The maximum number of requests allowed in the current time window.
- **X-RateLimit-Remaining** (integer) - The number of requests remaining in the current time window.
- **X-RateLimit-Reset** (integer) - The time in seconds until the rate limit resets.
### Response
#### Success Response (200)
- **report** (object) - A CustomReportDetails object containing detailed information about the custom report.
#### Response Example
```json
{
"report_id": "example_report_id",
"name": "Example Custom Report",
"created_at": "2023-10-27T10:00:00+00:00",
"data": [
{
"metric": "opens",
"value": 1500
},
{
"metric": "clicks",
"value": 300
}
]
}
```
```
--------------------------------
### Sample JSON Response for Click Track List
Source: https://apireference.getresponse.com/
Example of a successful JSON response when fetching a list of click tracks.
```json
[
{
"clickTrackId": "C12t",
"name": "Click here",
"url": "https://example.com/shop",
"clicks": 25951,
"message":
{
"resourceId": "r35N",
"type": "broadcast",
"createdOn": "2019-12-01T08:21:28+0000",
"resourceType": "newsletters",
"href": "https://api.getresponse.com/v3/newsletters/r35N"
},
"href": "https://api.getresponse.com/v3/click-tracks/C12t"
}
]
```
--------------------------------
### GET /splittests/{splittestId}
Source: https://apireference.getresponse.com/open-api.json
Retrieves details for a specific A/B test. Use this endpoint to get comprehensive information about a single A/B test by its ID.
```APIDOC
## GET /splittests/{splittestId}
### Description
Retrieves details for a specific A/B test. Use this endpoint to get comprehensive information about a single A/B test by its ID.
### Method
GET
### Endpoint
/splittests/{splittestId}
### Parameters
#### Path Parameters
- **splittestId** (string) - Required - The unique identifier of the A/B test.
### Headers
- **X-RateLimit-Limit** (integer) - The maximum number of requests allowed in the current time window.
- **X-RateLimit-Remaining** (integer) - The number of requests remaining in the current time window.
- **X-RateLimit-Reset** (integer) - The time in seconds until the rate limit resets.
### Response
#### Success Response (200)
- **splittest** (object) - A Splittest object containing detailed information about the A/B test.
#### Response Example
```json
{
"splittest_id": "example_splittest_id",
"name": "Example Split Test",
"campaign_id": "example_campaign_id",
"created_at": "2023-10-27T10:00:00+00:00",
"updated_at": "2023-10-27T10:00:00+00:00",
"status": "running"
}
```
```
--------------------------------
### Products
Source: https://apireference.getresponse.com/open-api.json
API documentation for managing products.
```APIDOC
## Products API
### Description
Endpoints for retrieving and managing product information.
### Method
GET, POST, PUT, DELETE (specific methods not detailed in source)
### Endpoint
/products (example path)
### Parameters
(Not specified in source)
### Request Example
(Not specified in source)
### Response
(Not specified in source)
```
--------------------------------
### Get list of 'From' addresses
Source: https://apireference.getresponse.com/
Use this GET request to retrieve a list of 'From' email addresses. Filtering and sorting are supported via query parameters.
```http
GET /from-fields
```
--------------------------------
### 200 OK - Order Details Sample
Source: https://apireference.getresponse.com/
This is a sample JSON response for a successful request to retrieve order details. It includes information about selected variants, order identifiers, pricing, addresses, and meta fields.
```json
{
"selectedVariants": [
{
"categories": [
{
"categoryId": "atQ",
"href": "https://api.getresponse.com/v3/shops/pf3/categories/atQ",
"name": "Headwear",
"parentId": "amh",
"isDefault": true,
"url": "https://somedomain.com/category/446",
"externalId": "ext3343"
}
],
"href": "https://api.getresponse.com/v3/shops/aS/products/Rf/variants/aBc",
"variantId": "p",
"price": 840,
"priceTax": 428,
"quantity": "2",
"taxes": [
{
"taxId": "Sk",
"href": "https://api.getresponse.com/v3/shops/pf3/taxes/Sk",
"name": "VAT",
"rate": 23
}
]
}
],
"orderId": "fOh",
"href": "https://api.getresponse.com/v3/shops/pf3/orders/fOh",
"contactId": "k8u",
"orderUrl": "https://somedomain.com/orders/order446",
"externalId": "DH71239",
"totalPrice": 716,
"totalPriceTax": 358.67,
"currency": "PLN",
"status": "NEW",
"cartId": "QBNgBR",
"description": "More information about order.",
"shippingPrice": 23,
"shippingAddress": {
"addressId": "k9",
"href": "https://api.getresponse.com/v3/addresses/k9",
"countryCode": "POL",
"countryName": "Poland",
"name": "some_shipping_address",
"firstName": "John",
"lastName": "Doe",
"address1": "Arkonska 6",
"address2": "",
"city": "Gdansk",
"zip": "80-387",
"province": "pomorskie",
"provinceCode": "",
"phone": "1122334455",
"company": "GetResponse",
"createdOn": "2026-06-18T09:09:52+00:00",
"updatedOn": "2026-06-18T09:09:52+00:00"
},
"billingStatus": "PENDING",
"billingAddress": {
"addressId": "k9",
"href": "https://api.getresponse.com/v3/addresses/k9",
"countryCode": "POL",
"countryName": "Poland",
"name": "some_shipping_address",
"firstName": "John",
"lastName": "Doe",
"address1": "Arkonska 6",
"address2": "",
"city": "Gdansk",
"zip": "80-387",
"province": "pomorskie",
"provinceCode": "",
"phone": "1122334455",
"company": "GetResponse",
"createdOn": "2026-06-18T09:09:52+00:00",
"updatedOn": "2026-06-18T09:09:52+00:00"
},
"processedAt": "2026-06-18T09:09:52+00:00",
"metaFields": [
{
"href": "https://api.getresponse.com/v3/shops/pf3/meta-fields/NoF",
"metaFieldId": "NoF",
"name": "Shoe size",
"value": "11",
"valueType": "integer",
"description": "Description of this meta field"
}
]
}
```
--------------------------------
### Get Balance Statistics Response Sample
Source: https://apireference.getresponse.com/
This is a sample JSON response for the Get balance statistics endpoint. It includes details on removals and subscriptions, grouped by date.
```json
[
{
"2014-12-05": {
"removals": {
"user": 5
},
"subscriptions": {
"import": 0,
"email": 0,
"www": 0,
"panel": 0,
"leads": 0,
"sale": 0,
"api": 7,
"forward": 0,
"survey": 0,
"mobile": 0,
"copy": 0,
"landing_page": 0,
"webinar": 4,
"premium_newsletter": 1,
"course": 1,
"summary": 13
}
},
"2015-01-21": {
"removals": {
"user": 10
}
}
}
]
```
--------------------------------
### Create File Response (201)
Source: https://apireference.getresponse.com/
This is a sample successful response (201 Created) when a file is successfully added to the GetResponse File Library. It includes details such as file ID, size, URL, and creation properties.
```json
{
"fileId": "6rZ6",
"fileSize": 579644,
"group": "photo",
"thumbnail": "https://us-rs.gr-cdn.com/512x,sBIbGHAUIQfw7kTUjaD0fTzxfXPggsY_1WCWIKl3RAxE=/https://multimedia.getresponse.com/getresponse-ZJtEw/photos/05c53ab1-6119-4076-a96c-bbefa082ea1a.jpg",
"url": "https://multimedia.getresponse.com/getresponse-ZJtEw/photos/05c53ab1-6119-4076-a96c-bbefa082ea1a.jpg",
"properties":
[
{
"name": "width",
"value": 1980
}
],
"createdOn": "2019-10-12T15:15:49+0000",
"href": "https://api.getresponse.com/v3/file-library/files/6pS",
"name": "image",
"extension": "jpg",
"folder":
{
"folderId": "4a9f"
}
}
```
--------------------------------
### Get Removal Statistics Response Sample
Source: https://apireference.getresponse.com/
This is a sample JSON response for the Get removal statistics endpoint. It shows the number of removed contacts grouped by date.
```json
[
{
"2014-12-05": {
"user": 5
},
"2015-01-22": {
"user": 12,
"bounce": 2
}
}
]
```
--------------------------------
### Sample A/B Test Response (200 OK)
Source: https://apireference.getresponse.com/
Provides an example of a successful response when retrieving A/B test data. Includes details like ID, name, campaign information, status, and delivery settings.
```json
[
{
"abTestId": "A3r",
"name": "A/B test",
"campaign":
{
"campaignId": "C",
"href": "https://api.getresponse.com/v3/campaigns/C"
},
"fromField":
{
"fromFieldId": "V",
"href": "https://api.getresponse.com/v3/from-fields/V"
},
"replyTo":
{
"fromFieldId": "V",
"href": "https://api.getresponse.com/v3/from-fields/V"
},
"status": "active",
"stage": "preparing",
"deliverySettings":
{
"sendOn":
{
"date": "2015-07-25T20:05:10+0000",
"timeZone":
{
"timeZoneId": 0,
"timeZoneName": 0,
"timeZoneOffset": 0
}
},
"winnerMode": "automatic",
"winningCriteria": "open",
"samplingPercentage": 1,
"samplingTime": "86400"
},
"flags":
[
"clicktrack"
],
"createdOn": "2015-07-25T20:05:10+0000",
"updatedOn": "2015-07-25T20:05:10+0000",
"href": "https://api.getresponse.com/v3/ab-tests/subject/A3r"
}
]
```
--------------------------------
### 429 Too Many Requests Error Example
Source: https://apireference.getresponse.com/open-api.json
Example of a rate limiting error response. This indicates that the API request limit has been reached and suggests waiting for the next quota window.
```json
{
"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"
}
```
--------------------------------
### 200 OK - Product and Variant Details
Source: https://apireference.getresponse.com/
This snippet shows a successful response (200 OK) containing detailed information about a product and its variants, including pricing, images, and meta fields. It's useful for retrieving complete product data.
```json
{
"productId": "9I",
"href": "https://api.getresponse.com/v3/shops/pf3/products/9I",
"name": "Monster Cap",
"type": "Headwear",
"url": "https://somedomomain.com/products/456",
"vendor": "GetResponse",
"externalId": "123456",
"categories": [
{
"categoryId": "atQ",
"href": "https://api.getresponse.com/v3/shops/pf3/categories/atQ",
"name": "Headwear",
"parentId": "amh",
"isDefault": true,
"url": "https://somedomain.com/category/446",
"externalId": "ext3343"
}
],
"variants": [
{
"variantId": "VTB",
"href": "https://api.getresponse.com/v3/shops/pf3/products/9I/variants/VTB",
"name": "Red Monster Cap",
"url": "https://somedomain.com/products-variants/986",
"sku": "SKU-1254-56-457-5689",
"price": 20,
"priceTax": 27.5,
"previousPrice": 25,
"previousPriceTax": 33.6,
"quantity": 1,
"position": 1,
"barcode": "12455687",
"externalId": "ext1456",
"description": "Red Cap with GetResponse Monster print",
"images": [
{
"imageId": "hY",
"href": "https://api.getresponse.com/v3/shops/pf3/images/hY",
"src": "http://somedomain.com/images/src/img58db7ec64bab9.png",
"position": "1"
}
],
"metaFields": [
{
"href": "https://api.getresponse.com/v3/shops/pf3/meta-fields/NoF",
"metaFieldId": "NoF",
"name": "Shoe size",
"value": "11",
"valueType": "integer",
"description": "Description of this meta field"
}
],
"taxes": [
{
"taxId": "Sk",
"href": "https://api.getresponse.com/v3/shops/pf3/taxes/Sk",
"name": "VAT",
"rate": 23
}
]
}
],
"metaFields": [
{
"href": "https://api.getresponse.com/v3/shops/pf3/meta-fields/NoF",
"metaFieldId": "NoF",
"name": "Shoe size",
"value": "11",
"valueType": "integer",
"description": "Description of this meta field"
}
],
"createdOn": "2026-06-18T09:09:52+00:00",
"updatedOn": "2026-06-18T09:09:52+00:00"
}
```
--------------------------------
### Create Cart
Source: https://apireference.getresponse.com/
Create a new shop cart.
```APIDOC
## POST /carts
### Description
Create cart.
### Method
POST
### Endpoint
/carts
```
--------------------------------
### Error Response Examples
Source: https://apireference.getresponse.com/open-api.json
Examples of error responses for different HTTP status codes, including 404 Not Found, 400 Bad Request, 401 Unauthorized, and 429 Too Many Requests.
```APIDOC
## Error Response Examples
This section provides examples of error responses for common HTTP status codes.
### 404 Not Found
**Description**: The requested resource was not found.
**Response Example**:
```json
{
"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 Bad Request
**Description**: Request validation error.
**Response Example**:
```json
{
"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 Unauthorized
**Description**: Authentication error.
**Response Example**:
```json
{
"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 Too Many Requests
**Description**: The throttling limit has been reached.
**Response Example**:
```json
{
"httpStatus": 429,
"code": 1015,
"codeDescription": "The throttling limit has been reached",
"message": "Rate limit exceeded. Please try again later.",
"moreInfo": "https:\/\/apidocs.getresponse.com\/en\/v3\/errors\/1015"
}
```
```
--------------------------------
### Example RSS Newsletter Response (200 OK)
Source: https://apireference.getresponse.com/
This is an example of a successful response when retrieving RSS newsletters. It includes details such as flags, IDs, URLs, subject, status, content, and send settings.
```json
[
{
"flags": "openrate,clicktrack,google_analytics",
"rssNewsletterId": "dGer",
"href": "https://api.getresponse.com/v3/rss-newsletters/dGer",
"rssFeedUrl": "http://blog.getresponse.com",
"subject": "My rss to newsletters",
"name": "rsstest0",
"status": "enabled",
"editor": "custom",
"fromField":
{
"fromFieldId": "V",
"href": "https://api.getresponse.com/v3/from-fields/V"
},
"replyTo":
{
"fromFieldId": "V",
"href": "https://api.getresponse.com/v3/from-fields/V"
},
"content":
{
"html": "test 12
Some test http://example.com
",
"plain": "test 12 Some test"
},
"sendSettings":
{
"frequency": "asap",
"filter": "recent",
"maxArticles": 1,
"selectedCampaigns":
[
"C"
],
"selectedSegments":
[
"Se"
],
"selectedSuppressions":
[
"Ss"
],
"excludedCampaigns":
[
"eC"
],
"excludedSegments":
[
"eSs"
]
},
"createdOn": "2026-06-18T09:09:52+00:00"
}
]
```