Retrieve event data
Retrieve instances of event completion data. For example, retrieve all event completions associated with a specific contact.
Supported products
Supported products
Marketing Hub -Enterprise
Sales Hub -Enterprise
Service Hub -Enterprise
Content Hub -Enterprise
Data Hub -EnterpriseRequired Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
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.
The event type name. You can retrieve available event types using the event types endpoint.
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.
The maximum number of results to display
The ID of the CRM Object to filter event instances on. When including this parameter, you must also include the objectType parameter.
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).
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).
Filter for event data that occurred after a specific datetime.
Filter for event data that occurred before a specific datetime.
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).
Sort direction (ascending or descending) based on the occurredAt timestamp of the event instance. To set the sort direction to ascending, pass occurredAt. To sort descending, add a minus prefix, like this: -occurredAT