APIs & Integrations

OOneTalk_test
Participant

Engagement/Association APIs filtering

Hi!

In case of our project, we need to get tasks, calls and notes for specific contact, deal or ticket and I would like to ask for advice on this matter. It seems that HubSpot api in terms of engagements specifically only allows for getting all of the engagements without any filtering.

We also know about associations api but we do not need all of the engagements for some object, only tasks, calls and notes.

Also we need to get object themselves, not ids, which is why this endpoint does not really work for us:

https://legacydocs.hubspot.com/docs/methods/crm-associations/get-associations

Could you please tell me:

Am I missing something/ not understanding something correctly?

If I am getting it alright, then can you advise me on what is the best solution for our case?

Maybe there are other endpoints better fit for this?

Currently, I am thinking about three options:

 

1) Get all engagements and sort them locally (probably too slow)

 

2) Use this deprecated endpoint to get engagements by id of an object with their bodies (not only ids):

https://legacydocs.hubspot.com/docs/methods/engagements/get_associated_engagements

But it is probably not a good idea to get to use deprecated endpoint.

 

3) Get engagement ids by id of an object and then get each one individually while sorting out the unneeded types. Sound like a lot of requests...

https://legacydocs.hubspot.com/docs/methods/crm-associations/get-associations

0 Upvotes
5 Replies 5
zaklein
Contributor | Diamond Partner
Contributor | Diamond Partner

Engagement/Association APIs filtering

Hi @OOneTalk_test 

With Engagements API V3 still in development, I think the most efficient solution here (at least in the short term) is to use the "Get Associated Engagements" endpoint: https://legacydocs.hubspot.com/docs/methods/engagements/get_associated_engagements

As you mention, it's not ideal to rely on a deprecated endpoint, but I don't see an efficient alternative at the moment.

I'm hopeful that Engagements API V3 will solve the problem efficiently with a "Get Batch of Engagements" endpoint, similar to the operations available for other object types within CRM API V3. @dennisedson Is there any publicly available timeline on when we might see Engagements API V3?

All the best,

Zach

dennisedson
HubSpot Product Team
HubSpot Product Team

Engagement/Association APIs filtering

@zaklein , nothing publicly available, yet, but they are making big strides on it. 

0 Upvotes
dennisedson
HubSpot Product Team
HubSpot Product Team

Engagement/Association APIs filtering

Looks like we have a beta out there now 😀

Link to docs!

0 Upvotes
zaklein
Contributor | Diamond Partner
Contributor | Diamond Partner

Engagement/Association APIs filtering

Awesome 👏

Thanks for the update @dennisedson 

dennisedson
HubSpot Product Team
HubSpot Product Team

Engagement/Association APIs filtering

@tominal , @zaklein , @Bryantworks 

Any of you have some suggestions for @OOneTalk_test ?

0 Upvotes