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

API documentation for contacts and their properties (e.g., tags, custom fields) The Contacts area of the GetResponse API v3 — 11 operation(s) across 8 path(s), split by tag from the provider-published OpenAPI at https://apireference.getresponse.com/open-api.json.

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

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

This API exposes 11 operations across 8 paths, and defines 25 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.

11 operations 8 paths 25 schemas 1 DELETE5 GET5 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 Contacts 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 11

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

Contacts 11

API documentation for contacts and their properties (e.g., tags, custom fields)

GET
/contacts/{contactId}/activities
Get a list of contact activities
getActivities 6 params → 200400401429
GET
/campaigns/{campaignId}/contacts
Get contacts from a single campaign
getContactsFromCampaign 11 params → 200400401429
POST
/contacts/{contactId}/custom-fields
Upsert the custom fields of a contact
upsertContactCustoms 1 param body → 200404400401429
POST
/contacts/{contactId}/tags
Upsert the tags of a contact
upsertTags 1 param body → 200404400401429
GET
/contacts/{contactId}
Get contact details by contact ID
getContactById 2 params → 200404400401429
POST
/contacts/{contactId}
Update contact details
updateContact 1 param body → 200404409400401429
DELETE
/contacts/{contactId}
Delete a contact by contact ID
deleteContact 3 params → 204404400401429
GET
/contacts
Get contact list
getContactList 17 params → 200400401429
POST
/contacts
Create a new contact
createContact body → 202409400401429
POST
/contacts/batch
Create multiple contacts at once
createBatchContacts body → 202409400401429
GET
/contacts/{contactId}/consents
Get contact's consent fields
getContactConsentsById 2 params → 200400401429

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Contact (13 properties), ContactGeolocation (8 properties), ErrorResponse (7 properties), ContactCustomFieldValue (7 properties). Each schema is shown below with its type and property counts.

CampaignReference
object
3 properties 1 required
Contact
object
13 properties 3 required
ContactActivity
object
6 properties
ContactActivityClickTrack
object
3 properties
ContactActivityResource
object
3 properties
ContactConsent
object
5 properties
ContactConsentHistoryItem
object
4 properties
ContactCustomField
object
2 properties
ContactCustomFieldList
array
ContactCustomFieldValue
object
7 properties 5 required
ContactDetails
object
ContactGeolocation
object
8 properties
ContactListElement
ContactTag
object
4 properties
DateOrDateTime
ErrorResponse
object
7 properties 7 required
NewContact
object
2 required
NewContactCustomFieldValue
object
2 properties 2 required
NewContactCustomFieldValues
object
1 property
NewContactTag
object
1 property 1 required
NewContactTags
object
1 property
SortOrderEnum
string
UpdateContact
object
UpsertContactCustomFields
object
1 required
UpsertContactTags
object
1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

getresponse-contacts-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 Custom Events API
GetResponse Custom Fields API
Where this information came from

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