List events
https://email.growthdept.ai/api/eventsEvents in the account, newest first unless sort says otherwise.
Sort by datetime, timestamp, ascending or descending (put - in front).
Rate limits
Scopes
events:read
Operation id
get_events The same operation as in Klaviyo's API. OpenAPI document
Query parameters
Pick values to add them to the request:
Pick values to add them to the request:
Pick values to add them to the request:
Pick values to add them to the request:
Fields and the operators each one takes:
- metric_id: equals
- profile_id: equals
- properties.<key>: equals
- datetime: greater-than, greater-or-equal, less-than, less-or-equal
- timestamp: greater-than, greater-or-equal, less-than, less-or-equal
Pick values to add them to the request:
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
200Success
Response body
object
dataarray of objectsrequired
data: 5 fields
typestringrequired
eventidstringrequired
attributesobjectrequired
attributes: 4 fields
timestampintegercan be null
event_propertiesobjectcan be null
datetimestring (date-time)can be null
uuidstringcan be null
relationshipsobject
relationships: 3 fields
profileobject
profile: 2 fields
dataobject
data: 2 fields
typestringrequired
profileidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
metricobject
metric: 2 fields
dataobject
data: 2 fields
typestringrequired
metricidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
attributionsobject
attributions: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
attributionidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
linksobject
links: 3 fields
selfstring (uri)required
prevstring (uri)
nextstring (uri)
metaobject
includedarray of objects
One option: MetricResponseObjectResource
typestringrequired
metricidstringrequired
attributesobjectrequired
attributes: 4 fields
namestringcan be null
createdstringcan be null
updatedstringcan be null
integrationobjectcan be null
relationshipsobject
relationships: 1 field
flow-triggersobject
flow-triggers: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
flowidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
One option: ProfileResponseObjectResource
typestringrequired
profileidstringcan be null
attributesobjectrequired
attributes: 14 fields
emailstringcan be null
phone_numberstringcan be null
external_idstringcan be null
first_namestringcan be null
last_namestringcan be null
organizationstringcan be null
localestringcan be null
titlestringcan be null
imagestringcan be null
createdstring (date-time)can be null
updatedstring (date-time)can be null
last_event_datestring (date-time)can be null
locationobjectcan be null
location: 10 fields
address1stringcan be null
address2stringcan be null
citystringcan be null
countrystringcan be null
latitudeone ofcan be null
One option: string
No fields.
One option: number
No fields.
longitudeone ofcan be null
One option: string
No fields.
One option: number
No fields.
regionstringcan be null
zipstringcan be null
timezonestringcan be null
ipstringcan be null
propertiesobjectcan be null
relationshipsobject
relationships: 3 fields
listsobject
lists: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
listidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
segmentsobject
segments: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
segmentidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
push-tokensobject
push-tokens: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
push-tokenidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
One option: AttributionResponseObjectResource
typestringrequired
attributionidstringrequired
relationshipsobject
relationships: 7 fields
eventobject
event: 2 fields
dataobject
data: 2 fields
typestringrequired
eventidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
attributed-eventobject
attributed-event: 2 fields
dataobject
data: 2 fields
typestringrequired
eventidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
campaignobject
campaign: 2 fields
dataobject
data: 2 fields
typestringrequired
campaignidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
campaign-messageobject
campaign-message: 2 fields
dataobject
data: 2 fields
typestringrequired
campaign-messageidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
flowobject
flow: 2 fields
dataobject
data: 2 fields
typestringrequired
flowidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
flow-messageobject
flow-message: 2 fields
dataobject
data: 2 fields
typestringrequired
flow-messageidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
flow-message-variationobject
flow-message-variation: 2 fields
dataobject
data: 2 fields
typestringrequired
flow-messageidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject