Get an engagement

Last updated June 17, 2020

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:

contacts

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 API key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.