GetResponse Custom Fields API
Custom Fields API documentation The Custom Fields 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 Custom Fields
version: 3.2026-07-28T07:58:55+00:00
description: The Custom Fields 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: Custom Fields
description: Custom Fields API documentation
paths:
/custom-fields/{customFieldId}:
get:
tags:
- Custom Fields
summary: Get a single custom field definition by the custom field ID
description: Returns a list of custom fields
operationId: getCustomFieldById
parameters:
- $ref: '#/components/parameters/Fields'
responses:
'200':
$ref: '#/components/responses/CustomFieldDetails'
'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/customFieldId'
post:
tags:
- Custom Fields
summary: Update the custom field definition
operationId: updateCustomField
requestBody:
$ref: '#/components/requestBodies/UpdateCustomField'
responses:
'200':
$ref: '#/components/responses/CustomFieldDetails'
'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:
- Custom Fields
summary: Delete a single custom field definition
operationId: deleteCustomField
responses:
'204':
description: Delete a custom field.
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
/custom-fields:
get:
tags:
- Custom Fields
summary: Get a list of custom fields
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: getCustomFieldList
parameters:
- name: query[name]
in: query
description: Search custom fields by name
required: false
schema:
type: string
- name: sort[name]
in: query
description: Sort by name
required: false
schema:
$ref: '#/components/schemas/SortOrderEnum'
- $ref: '#/components/parameters/Fields'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Page'
responses:
'200':
$ref: '#/components/responses/CustomFieldList'
'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:
- Custom Fields
summary: Create a custom field
operationId: createCustomField
requestBody:
$ref: '#/components/requestBodies/NewCustomField'
responses:
'201':
$ref: '#/components/responses/CustomFieldDetails'
'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
customFieldId:
name: customFieldId
in: path
description: 'Unique identifier of the custom field. You can retrieve this ID from the [list of
custom fields](https://apireference.getresponse.com/#operation/getCustomFieldList) field: `customFieldId`.'
required: true
schema:
type: string
example: pas
requestBodies:
NewCustomField:
content:
application/json:
schema:
$ref: '#/components/schemas/NewCustomField'
UpdateCustomField:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCustomField'
responses:
CustomFieldDetails:
description: The custom field 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/CustomFieldResponse'
CustomFieldList:
description: The list of custom fields
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/CustomField'
schemas:
CustomField:
properties:
customFieldId:
description: Custom field ID
type: string
readOnly: true
example: pas
href:
description: Direct hyperlink to a resource
type: string
format: uri
readOnly: true
example: https://api.getresponse.com/v3/custom-fields/pas
name:
description: "The name of the custom field. It must meet the following requirements:\n * be\
\ unique\n * use only lowercase letters, underscores and digits\n * not be equal to one of\
\ the merge words used in messages, i.e. `name, email, twitter, facebook, buzz, myspace, linkedin,\
\ digg, googleplus, pinterest, responder, campaign, change`."
type: string
maxLength: 128
minLength: 1
example: office_phone_number
type:
description: "The custom field `type` accepts the following values:\n * `string` - input for\
\ a string value\n * `number` - input for a numeric value\n * `date` - input for a date\n\
\ * `datetime` - input for date and time\n * `country` - input for a country\n * `currency`\
\ - input for a currency, allows all ISO 4217 currency codes\n * `phone` - input for a phone\
\ number\n * `gender` - input for gender, allows `Male`, `Female` or `Prefer not to say`\n\
\ * `ip` - input for an IP address\n * `url` - input for a URL."
example: phone
allOf:
- $ref: '#/components/schemas/CustomFieldTypeEnum'
valueType:
description: Type of returning value, it returns `type` options extended by a `string` option
if the `format` was not defined
type: string
enum:
- string
- number
- date
- datetime
- country
- currency
- phone
- gender
- ip
- url
readOnly: true
example: phone
format:
description: "The custom field `format` accepts following values:\n * `text` - text input (doesn't\
\ require values in the `values` field, you can pass empty array)\n * `textarea` - textarea\
\ input (doesn't require values in the `values` field, you can pass empty array)\n * `radio`\
\ - radio input (requires at least 2 values in the `values` field)\n * `checkbox` - checkbox\
\ input (doesn't require values in the `values` field, you can pass empty array)\n * `single_select`\
\ - single select input (requires at least 2 values in the `values` field)\n * `multi_select`\
\ - multi select input (requires at least 2 values in the `values` field)."
example: text
allOf:
- $ref: '#/components/schemas/CustomFieldFormatEnum'
fieldType:
description: Returns the same as `format`
type: string
readOnly: true
example: text
deprecated: true
hidden:
description: Whether the custom field is visible to contacts
example: 'false'
allOf:
- $ref: '#/components/schemas/StringBooleanEnum'
values:
description: The list of assigned default values, starting from zero depending on the custom
field format. (Please see description).
type: array
items:
type: string
example: '+48600100200'
type: object
CustomFieldFormatEnum:
type: string
enum:
- text
- textarea
- radio
- checkbox
- single_select
- multi_select
CustomFieldResponse:
properties:
customFieldId:
description: Custom field ID
type: string
readOnly: true
example: pas
href:
description: Direct hyperlink to a resource
type: string
format: uri
readOnly: true
example: https://api.getresponse.com/v3/custom-fields/pas
name:
description: The name of the custom field
type: string
example: office_phone_number
type:
example: phone
allOf:
- $ref: '#/components/schemas/CustomFieldTypeEnum'
valueType:
description: Type of returning value, it returns `type` options extended by a `string` option
if the `format` was not defined
type: string
readOnly: true
example: radio
format:
example: text
allOf:
- $ref: '#/components/schemas/CustomFieldFormatEnum'
fieldType:
description: Returns the same as `format`
type: string
readOnly: true
example: text
deprecated: true
hidden:
description: Whether the custom field is visible to contacts
example: 'false'
allOf:
- $ref: '#/components/schemas/StringBooleanEnum'
values:
description: The list of assigned default values, starting from zero depending on the custom
field format. (Please see description).
type: array
items:
type: string
example: '+48600100200'
type: object
CustomFieldTypeEnum:
type: string
enum:
- string
- number
- date
- datetime
- country
- currency
- phone
- gender
- ip
- url
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
NewCustomField:
required:
- name
- type
- format
- hidden
- values
type: object
allOf:
- $ref: '#/components/schemas/CustomField'
SortOrderEnum:
type: string
enum:
- ASC
- DESC
StringBooleanEnum:
type: string
enum:
- 'true'
- 'false'
UpdateCustomField:
required:
- hidden
- values
properties:
hidden:
description: Whether the custom field is visible to contacts
example: 'false'
allOf:
- $ref: '#/components/schemas/StringBooleanEnum'
values:
description: The list of assigned values (zero or more - depending on the custom field type.
Please see description)
type: array
items:
type: string
example: '+48600100200'
type: object
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