GET an Engagement

Last updated November 11, 2019

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

Get an engagement (a task or activity) on an object in HubSpot. This data is often used for per rep productivity reporting or integration with other back-office tools.

Note: 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 Engagements 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.

Optional ParametersHow to useDescription
None None No optional parameters for this method.