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

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.

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

Tagged areas include Custom Fields. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 3.2026-07-28T07:58:55+00:00.

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

5 operations 2 paths 9 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

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

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

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Fields 5

Custom Fields API documentation

GET
/custom-fields/{customFieldId}
Get a single custom field definition by the custom field ID
getCustomFieldById 2 params → 200404400401429
POST
/custom-fields/{customFieldId}
Update the custom field definition
updateCustomField 1 param body → 200404400401429
DELETE
/custom-fields/{customFieldId}
Delete a single custom field definition
deleteCustomField 1 param → 204404400401429
GET
/custom-fields
Get a list of custom fields
getCustomFieldList 5 params → 200400401429
POST
/custom-fields
Create a custom field
createCustomField body → 201400401429

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are CustomFieldResponse (9 properties), CustomField (9 properties), ErrorResponse (7 properties), UpdateCustomField (2 properties). Each schema is shown below with its type and property counts.

CustomField
object
9 properties
CustomFieldFormatEnum
string
CustomFieldResponse
object
9 properties
CustomFieldTypeEnum
string
ErrorResponse
object
7 properties 7 required
NewCustomField
object
5 required
SortOrderEnum
string
StringBooleanEnum
string
UpdateCustomField
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

getresponse-custom-fields-openapi.yml Raw ↑

Other APIs GetResponse publishes across the network.

GetResponse API v3
GetResponse A/B tests API
GetResponse A/B tests - subject API
GetResponse Accounts API
GetResponse Addresses API
GetResponse Autoresponders API
GetResponse Campaigns (Lists) API
GetResponse Carts API
GetResponse Categories API
GetResponse Click Tracks API
GetResponse Contacts API
GetResponse Custom Events API
Where this information came from

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

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

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

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