v1

latestOpenAPI 3.0.12026-07-14167.8 KB
Events

Returns a collection of events matching a query.

get/events/v3/events

Query parameters

occurredAfterstring date-time

The starting time as an ISO 8601 timestamp.

occurredBeforestring date-time

The ending time as an ISO 8601 timestamp.

objectTypestring

The type of object being selected. Valid values are hubspot named object types (e.g. contact).

objectIdinteger

The id of the selected object. If not present, then the objectProperty parameter is required.

eventTypestring

Limits the response to the specified event type. For example &eventType=e_visited_page returns only e_visited_page events. If not present all event types are returned.

afterstring

An additional parameter that may be used to get the next limit set of results.

beforestring
limitinteger

The maximum number of events to return, defaults to 20.

sortstring[]

Selects the sort field and order. Defaults to ascending, prefix with - for descending order. occurredAt is the only field supported for sorting.

Response

successful operation

All 1 operations