2.8 KiB
2.8 KiB
GetResponse Routing Reference
App name: getresponse
Base URL proxied: api.getresponse.com
API Path Pattern
/getresponse/v3/{resource}
Common Endpoints
Get Account Details
GET /getresponse/v3/accounts
List Campaigns
GET /getresponse/v3/campaigns
Query parameters:
page- Page number (starts at 1)perPage- Records per page (max 1000)
Get Campaign
GET /getresponse/v3/campaigns/{campaignId}
Create Campaign
POST /getresponse/v3/campaigns
Content-Type: application/json
{
"name": "My Campaign"
}
List Contacts
GET /getresponse/v3/contacts?page=1&perPage=100
Query parameters:
query[campaignId]- Filter by campaignquery[email]- Filter by emailsort[createdOn]- Sort by creation date (asc/desc)
Get Contact
GET /getresponse/v3/contacts/{contactId}
Create Contact
POST /getresponse/v3/contacts
Content-Type: application/json
{
"email": "user@example.com",
"name": "John Doe",
"campaign": {
"campaignId": "abc123"
}
}
Update Contact
POST /getresponse/v3/contacts/{contactId}
Content-Type: application/json
{
"name": "Jane Doe"
}
Delete Contact
DELETE /getresponse/v3/contacts/{contactId}
List Custom Fields
GET /getresponse/v3/custom-fields
List Tags
GET /getresponse/v3/tags
Create Tag
POST /getresponse/v3/tags
Content-Type: application/json
{
"name": "VIP Customer"
}
List Segments
GET /getresponse/v3/search-contacts
Get Contacts from Segment
GET /getresponse/v3/search-contacts/{searchContactId}/contacts
Send Newsletter
POST /getresponse/v3/newsletters
Content-Type: application/json
{
"subject": "Newsletter Subject",
"name": "Internal Name",
"campaign": {
"campaignId": "abc123"
},
"content": {
"html": "<html><body>Content</body></html>",
"plain": "Content"
},
"sendOn": "2026-02-15T10:00:00Z"
}
List Autoresponders
GET /getresponse/v3/autoresponders
List From Fields
GET /getresponse/v3/from-fields
Notes
- Campaign IDs and Contact IDs are alphanumeric strings (e.g., "fZ0Xg", "VZ4Sa5g")
- Timestamps are in ISO 8601 format
- Field names use camelCase
- Use page-based pagination with
pageandperPageparameters - Rate limits: 30,000 requests per 10 minutes, 80 requests per second
- "Campaigns" in GetResponse are equivalent to email lists/audiences
- "Search contacts" and "segments" refer to the same resource