GET
/
events
/
v3
/
events
/
Retrieve event data
curl --request GET \
  --url https://api.hubapi.com/events/v3/events/ \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "next": {
      "link": "",
      "after": ""
    },
    "prev": {
      "before": "",
      "link": ""
    }
  },
  "results": [
    {
      "occurredAt": "2023-11-07T05:31:56Z",
      "eventType": "<string>",
      "id": "<string>",
      "objectId": "<string>",
      "properties": {},
      "objectType": "<string>"
    }
  ]
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubEnterprise
Sales HubSales HubEnterprise
Service HubService HubEnterprise
Content HubContent HubEnterprise

​
Required Scopes

This API requires one of the following scopes:
  • oauth

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
objectType
string

The type of CRM object to filter event instances on (e.g., contact). To retrieve event data for a specific CRM record, include the additional objectId query parameter (below).

​
eventType
string

The event type name. You can retrieve available event types using the event types endpoint.

​
after
string

The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results.

​
before
string
​
limit
integer

The maximum number of results to display per page.

​
sort
string[]

Sort direction based on the timestamp of the event instance, ASCENDING or DESCENDING.

​
occurredAfter
string<date-time>

Filter for event data that occurred after a specific datetime.

​
occurredBefore
string<date-time>

Filter for event data that occurred before a specific datetime.

​
objectId
integer

The ID of the CRM Object to filter event instances on. When including this parameter, you must also include the objectType parameter.

​
objectProperty.{propname}
object

Instead of retrieving event data for a specific object by its ID, you can specify a unique identifier property. For contacts, you can use the email property. (e.g., objectProperty.email=name@domain.com).

​
property.{propname}
object

Filter for event completions that contain a specific value for an event property (e.g., property.hs_city=portland). For properties values with spaces, replaces spaces with %20 or + (e.g., property.hs_city=new+york).

​
id
string[]

ID of an event instance. IDs are 1:1 with event instances. If you provide this filter and additional filters, the other filters must match the values on the event instance to yield results.

Response

200
application/json

successful operation

The response is of type object.