There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Get all engagements

Last updated May 15, 2023

GET /engagements/v1/engagements/paged

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM

Required Scope:

crm.objects.companies.read
crm.objects.contacts.read
crm.objects.deals.read
tickets
e-commerce

This endpoint is used to get all engagements in an account. 

Use case for this endpoint: Because engagements represent individual activity, you can use the endpoint to source the inputs for a machine learning model to help predict the best time for a call to a prospect or a customer. 

Scopes

In addition to the contacts scope, the sales-email-read scope is required to receive the details of any email-type engagements. See the Engagements API Overview for more details.

Response details

Returns a paginated set of engagements. Up to 250 records can be returned in a single response.

In addition to the list of engagements, each request will also return two values, offset and hasMore. If hasMore is true, you'll need to make another request, using the offset to get the next page of engagement records.

This endpoint will not return engagements for sample contacts "Brian Halligan" or "Cool Robot."

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.

Optional Parameters How to use Description
Limit limit=
Used in the request URL		 The number of records to return. Defaults to 100, has a maximum value of 250.
Offset offset=
Used in the request URL		 Used to page through the results. If there are more records in your portal than the limit= parameter, you will need to use the offset returned in the first request to get the next set of results.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: https://api.hubapi.com/engagements/v1/engagements/paged?limit=2 { "results": [ { "engagement": { "id": 29090716, "portalId": 62515, "active": true, "createdAt": 1444223400781, "lastUpdated": 1444223400781, "createdBy": 215482, "modifiedBy": 215482, "ownerId": 70, "type": "NOTE", "timestamp": 1444223400781 }, "associations": { "contactIds": [ 247 ], "companyIds": [ ], "dealIds": [ ], "ownerIds": [ ], "workflowIds": [ ] }, "attachments": [ ], "metadata": { "body": "This is a test note " } }, { "engagement": { "id": 4709059, "portalId": 62515, "active": true, "createdAt": 1428586724779, "lastUpdated": 1428586724779, "createdBy": 215482, "modifiedBy": 215482, "ownerId": 70, "type": "CALL", "timestamp": 1428565020000 }, "associations": { "contactIds": [ 832 ], "companyIds": [ 8347 ], "dealIds": [ ], "ownerIds": [ ], "workflowIds": [ ] }, "attachments": [ ], "metadata": { "durationMilliseconds": 24000, "body": "test call" } } ], "hasMore": true, "offset": 4623406 }