GET
/
email
/
public
/
v1
/
events
Get email events
curl --request GET \
  --url https://api.hubapi.com/email/public/v1/events \
  --header 'Authorization: Bearer <token>'
{
  "events": [
    {
      "appId": 123,
      "appName": "<string>",
      "browser": {
        "family": "<string>",
        "name": "<string>",
        "producer": "<string>",
        "producerUrl": "<string>",
        "type": "<string>",
        "url": "<string>",
        "version": [
          "<string>"
        ]
      },
      "created": 123,
      "emailCampaignId": 123,
      "hmid": "<string>",
      "id": "<string>",
      "location": {
        "city": "<string>",
        "country": "<string>",
        "state": "<string>",
        "latitude": 123,
        "longitude": 123
      },
      "portalId": 123,
      "recipient": "<string>",
      "response": "<string>",
      "sentBy": {
        "created": 123,
        "id": "<string>"
      },
      "sendId": "<string>",
      "smtpId": "<string>",
      "subject": "<string>",
      "type": "<string>",
      "userAgent": "<string>"
    }
  ],
  "hasMore": true,
  "offset": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
appId
integer

Only return events which correspond to the given HubSpot Application ID.

​
campaignId
integer

Only return events from the given HubSpot Campaign ID.

​
recipient
string

Only return events related to the given recipient.

​
eventType
string

Only return events of the specified type (case-sensitive).

​
startTimestamp
integer

Only return events which occurred at or after the given timestamp (in milliseconds since epoch).

​
endTimestamp
integer

Only return events which occurred at or before the given timestamp (in milliseconds since epoch).

​
offset
string

An offset token returned by a previous call to this endpoint.

​
limit
integer
default:10

The maximum number of events to return. If omitted, the default value of 10 is used. The maximum allowed value is 1000.

Required range: 1 <= x <= 1000
​
excludeFilteredEvents
boolean
default:false

Only return events that have not been filtered out due to customer filtering settings. The default value is false.

Response

200
application/json

Email events retrieved successfully

The response is of type object.