Lead Gen & CRM has a distinct API organization. This article will detail the methods listed within the Lead Gen & CRM API, related to Events.
| Administrators | ✓ | |
| Company Managers | ||
| Marketing Managers | ||
| Sales Managers | ||
| Salespersons | ||
| Jr. Salespersons |
This article provides specific method content about Lead Gen & CRM's API. However, given the size and scope of the API, information is broken up and is contained in different articles. Each article focuses on a specific function of Lead Gen & CRM's API. Additional API information can be found in the following articles:
getEventsImportant! getEvents has been replaced by getEventsByType. |
Retrieves a list of Lead Gen & CRM Lead events. Either a lead ID or an event timestamp can be specified. In the case when an event timestamp is specified, the API will return all events that happened after the given timestamp. Please note that Mail Sync events will not be returned. | |||||
| Params | Name | Type | Is Required | |||
| where |
hash | Required | ||||
| limit |
int | Optional | ||||
| offset |
int | Optional | ||||
| Return Data | Name | Type | ||||
|
fields | list<Event> | |||||
Retrieve a list of Lead events, by eventSource.
Either a leadID and/or an event timestamp MUST be provided. When a leadID is specified, only events for that lead will be returned. When a createTimestamp is specified, only events created after the timestamp will be returned. eventSource should be a comma-delimited string of the types of events you wish to fetch.
Each event type will the returned separately, ordered by timestamp. Valid eventSource values include:
callConvert, cartComplete, changeLeadStatus, dealStageChange, emailSent, emailOpened, emailClick, emailBounce, emailSpamComplaint, emailUnsubscribe, emailVisit, formSubmit, importantPageVisit, incomingCall, leadCreation, leadOwnerChange, mailboxRecv, mailboxSend, mailboxEmailOpen, mediaOpen, oppCreate, oppLost, oppWon, outgoingCall, pageVisit, referredOnTheForm, shoppingCartAbandoned
|
Name |
Type |
Is Required |
|
where |
hash Required: eventSource (and one of leadID or createTimestamp) |
Required |
|
limit |
int |
Optional |
|
offset |
int |
Optional |
|
Name |
Type |
|
result |
[eventSource => [events => list<Event>, hasMore => boolean, error => string|null]] |
Copyright © 2025 · All Rights Reserved · Constant Contact · Privacy Center