Get Associated Engagements

GET /engagements/v1/engagements/associated/:objectType/:objectId/paged

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM

Get associated engagements (tasks or activities) on an object in HubSpot. This data is often used for per rep productivity reporting or integration with other back-office tools.

The response will contain:

  • results: list of associated engagements
  • hasMore: boolean, true if there are more associated engagements
  • offset: long, value to use as offset parameter if making another request

 

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.
Object Type Used in the request URL (see above) One of contact, company, or deal, depending on the object you want to fetch engagements for.
Object ID Used in the request URL (see above) The ID of the associated object you want to fetch contacts for. This will be the vid for a contact, companyId for a company, or dealId for a deal.

Optional Parameters How to use Description
offset &offset=x Used to page through associated engagements if there are more than can be retrieved in one page. Defaults to 0.
limit &limit=x Set an upper limit on the number of engagements to fetch. Cannot be set higher than 100.