GetResponse Addresses API
Addresses API documentation The Addresses area of the GetResponse API v3 — 5 operation(s) across 2 path(s), split by tag from the provider-published OpenAPI at https://apireference.getresponse.com/open-api.json.
OpenAPI Specification
openapi: 3.0.0
info:
title: GetResponse APIv3 Addresses
version: 3.2026-07-28T07:58:55+00:00
description: The Addresses 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: Addresses
description: Addresses API documentation
paths:
/addresses/{addressId}:
get:
tags:
- Addresses
summary: Get an address by ID
description: ''
operationId: getAddress
parameters:
- $ref: '#/components/parameters/Fields'
responses:
'200':
$ref: '#/components/responses/AddressDetails'
'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
parameters:
- $ref: '#/components/parameters/addressId'
post:
tags:
- Addresses
summary: Update address
description: '
Update an existing address. You should send only those fields that need to be changed. The rest
of the properties will stay the same.
'
operationId: updateAddress
requestBody:
$ref: '#/components/requestBodies/UpdateAddress'
responses:
'200':
$ref: '#/components/responses/AddressDetails'
'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
delete:
tags:
- Addresses
summary: Delete address
description: ''
operationId: deleteAddress
responses:
'204':
description: Empty response
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
/addresses:
get:
tags:
- Addresses
summary: Get a list of addresses
description: "\nSending a **GET** request to this URL returns collection of address resources.\n\
\nYou can narrow down the list of resources by passing proper query parameters (the list of which\
\ you can find below in the request params section). You can basically search by:\n* name\n* firstName\n\
* lastName\n* address1\n* address2\n* city\n* zip\n* province\n* provinceCode\n* phone\n* company\n\
* createdOn\n\nThe `name` field can be a pattern and we'll try to match this phrase.\n\nYou can\
\ specify which page of the results you want and how many results per page to display. You can\
\ also specify the sort-order using one or more of the allowed fields (listed below in the request\
\ params section).\n\nLast but not least, you can even specify which fields from a resource you\
\ want to get. If you pass the param `fields` with the list of fields (separated by a comma [,])\
\ we'll return the list of resources with only those fields (we'll always add a resource ID to\
\ ensure that you can use that data later on)\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: getAddressList
parameters:
- name: query[name]
in: query
description: Search addresses by name
required: false
schema:
type: string
- name: query[firstName]
in: query
description: Search addresses by first name
required: false
schema:
type: string
- name: query[lastName]
in: query
description: Search addresses by last name
required: false
schema:
type: string
- name: query[address1]
in: query
description: Search addresses by address1 field
required: false
schema:
type: string
- name: query[address2]
in: query
description: Search addresses by address2 field
required: false
schema:
type: string
- name: query[city]
in: query
description: Search addresses by city
required: false
schema:
type: string
- name: query[zip]
in: query
description: Search addresses by ZIP
required: false
schema:
type: string
- name: query[province]
in: query
description: Search addresses by province
required: false
schema:
type: string
- name: query[provinceCode]
in: query
description: Search addresses by province code
required: false
schema:
type: string
- name: query[phone]
in: query
description: Search addresses by phone
required: false
schema:
type: string
- name: query[company]
in: query
description: Search addresses by company
required: false
schema:
type: string
- name: query[createdOn][from]
in: query
description: Search addresses created from this date
required: false
schema:
type: string
format: date-time
- name: query[createdOn][to]
in: query
description: Search addresses created to this date
required: false
schema:
type: string
format: date-time
- 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/AddressList'
'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:
- Addresses
summary: Create address
description: ''
operationId: createAddress
requestBody:
$ref: '#/components/requestBodies/NewAddress'
responses:
'201':
$ref: '#/components/responses/AddressDetails'
'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
components:
headers:
CurrentPage:
description: The current page number
schema:
type: integer
format: int32
RateLimitLimit:
description: The total number of requests available per time frame
schema:
type: integer
format: int32
RateLimitRemaining:
description: The number of requests left in the current time frame
schema:
type: integer
format: int32
RateLimitReset:
description: Seconds left in the current time frame, e.g. "432 seconds"
schema:
type: string
TotalCount:
description: The total number of resources found for the specified conditions
schema:
type: integer
format: int32
TotalPages:
description: The total number of pages
schema:
type: integer
format: int32
parameters:
Fields:
name: fields
in: query
description: List of fields that should be returned. Id is always returned. Fields should be separated
by comma
required: false
schema:
type: string
Page:
name: page
in: query
description: Page number
required: false
schema:
type: integer
format: int32
default: 1
minimum: 1
PerPage:
name: perPage
in: query
description: Requested number of results per page
required: false
schema:
type: integer
format: int32
default: 100
maximum: 1000
minimum: 1
addressId:
name: addressId
in: path
description: The address ID
required: true
schema:
type: string
example: k9
requestBodies:
NewAddress:
content:
application/json:
schema:
$ref: '#/components/schemas/NewAddress'
UpdateAddress:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAddress'
responses:
AddressDetails:
description: The address details
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
content:
application/json:
schema:
$ref: '#/components/schemas/Address'
AddressList:
description: The list of addresses.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
CurrentPage:
$ref: '#/components/headers/CurrentPage'
TotalPages:
$ref: '#/components/headers/TotalPages'
TotalCount:
$ref: '#/components/headers/TotalCount'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Address'
schemas:
Address:
type: object
allOf:
- properties:
addressId:
type: string
readOnly: true
example: k9
href:
description: Direct hyperlink to a resource
type: string
format: uri
readOnly: true
example: https://api.getresponse.com/v3/addresses/k9
countryCode:
description: The country code (ISO 3166-1 alpha-3)
type: string
maxLength: 3
minLength: 3
example: POL
countryName:
description: The country name, based on `countryCode`
type: string
readOnly: true
example: Poland
name:
type: string
maxLength: 128
minLength: 3
example: some_shipping_address
firstName:
type: string
maxLength: 64
minLength: 0
example: John
lastName:
type: string
maxLength: 64
minLength: 0
example: Doe
address1:
description: Address line 1
type: string
maxLength: 255
minLength: 0
example: Arkonska 6
address2:
description: Address line 2
type: string
maxLength: 255
minLength: 0
example: ''
city:
type: string
maxLength: 128
minLength: 0
example: Gdansk
zip:
description: The ZIP/postal code, free text
type: string
maxLength: 64
minLength: 0
example: 80-387
province:
type: string
maxLength: 255
minLength: 0
example: pomorskie
provinceCode:
description: The province code, free text
type: string
maxLength: 64
minLength: 0
example: ''
phone:
description: The phone number, free text
type: string
maxLength: 255
minLength: 0
example: '1122334455'
company:
description: The company name, free text
type: string
maxLength: 128
minLength: 0
example: GetResponse
- $ref: '#/components/schemas/CreateAndUpdate'
CreateAndUpdate:
properties:
createdOn:
description: The creation date
type: string
format: date-time
readOnly: true
updatedOn:
description: The date of the last update
type: string
format: date-time
readOnly: true
type: object
ErrorResponse:
required:
- httpStatus
- code
- codeDescription
- message
- moreInfo
- context
- uuid
properties:
httpStatus:
description: HTTP response code
type: integer
format: int32
code:
description: API error code
type: integer
format: int32
codeDescription:
description: API error code description
type: string
message:
description: Error message
type: string
moreInfo:
description: URL to error description in the API Docs
type: string
context:
type: object
uuid:
description: UUID of the error response
type: string
type: object
NewAddress:
required:
- name
- countryCode
type: object
allOf:
- $ref: '#/components/schemas/Address'
SortOrderEnum:
type: string
enum:
- ASC
- DESC
UpdateAddress:
type: object
allOf:
- $ref: '#/components/schemas/Address'
securitySchemes:
api-key:
type: apiKey
description: Header value must be prefixed with api-key
name: X-Auth-Token
in: header
oauth2:
type: oauth2
flows:
implicit:
authorizationUrl: https://app.getresponse.com/oauth2_authorize.html
scopes:
all: all data access
authorizationCode:
authorizationUrl: https://app.getresponse.com/oauth2_authorize.html
tokenUrl: https://api.getresponse.com/v3/token
scopes:
all: all data access
clientCredentials:
tokenUrl: https://api.getresponse.com/v3/token
scopes:
all: all data access