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 Events API

Custom Events API documentation The Custom Events area of the GetResponse API v3 — 6 operation(s) across 3 path(s), split by tag from the provider-published OpenAPI at https://apireference.getresponse.com/open-api.json.

GetResponse Custom Events 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 Events. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 12 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.

6 operations 3 paths 12 schemas 1 DELETE2 GET3 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 Events 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 6

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

Custom Events 6

Custom Events API documentation

GET
/custom-events/{customEventId}
Get custom events by custom event ID
getCustomEventById 2 params → 200404400401429
POST
/custom-events/{customEventId}
Update custom event details
updateCustomEvent 1 param body → 200404400401429
DELETE
/custom-events/{customEventId}
Delete a custom event by custom event ID
deleteCustomEvent 1 param → 204404400401429
GET
/custom-events
Get a list of custom events
getCustomEventsList 6 params → 200400401429
POST
/custom-events
Create custom event
createCustomEvent body → 201400401429
POST
/custom-events/trigger
Trigger a custom event
triggerCustomEvent body → 201404400401429

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (7 properties), TriggerCustomEvent (3 properties), CustomEvent (2 properties), TriggerCustomEventAttribute (2 properties). Each schema is shown below with its type and property counts.

CustomEvent
object
2 properties 2 required
CustomEventAttribute
object
2 properties 2 required
CustomEventAttributeDetails
object
1 required
CustomEventDetails
object
2 required
ErrorResponse
object
7 properties 7 required
NewCustomEvent
object
SortOrderEnum
string
StringBooleanEnum
string
TriggerCustomEvent
object
3 properties 2 required
TriggerCustomEventAttribute
object
2 properties 2 required
TriggerCustomEventAttributeValue
The value of the attribute. Value type depends on the attribute definition
UpdateCustomEvent
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

getresponse-custom-events-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 Fields API
Where this information came from

This is an independent, third-party profile of GetResponse Custom Events 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.