There's a new version of the HubSpot API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Get an engagement

Last updated May 15, 2023

GET /engagements/v1/engagements/:engagementId

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 an engagement (a task or activity) for a CRM record in HubSpot.

Use case for this endpoint: This data can be used to report on per-rep productivity or to integrate HubSpot with other back-office tools.

For another example, you can use this information about an individual call to drive automation about when the next follow-up meeting or call should happen.

Scopes

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

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.