topic Getting Associations in Batch APIs in APIs & Integrations

Getting Associations in Batch APIs

SR36 — Tue, 08 Mar 2022 06:30:30 GMT

Is there a way to retrieve associations in a Batch Read. For example, when retrieving a single contact, I can request for associations via the GET API as follows

curl --request GET --url https://api.hubapi.com/crm/v3/objects/contacts/251/\?associations\=notes --header 'authorization: Bearer <token>' | json_pp

% Total % Received % Xferd Average Speed Time Time Time Current

Dload Upload Total Spent Left Speed

100 432 0 432 0 0 352 0 --:--:-- 0:00:01 --:--:-- 357

{

"archived" : false,

"associations" : {

"notes" : {

"results" : [

{

"id" : "19668463257",

"type" : "contact_to_note"

{

"id" : "19793682071",

"type" : "contact_to_note"

}

]

}

"createdAt" : "2022-03-03T09:23:21.321Z",

"id" : "251",

"properties" : {

"createdate" : "2022-03-03T09:23:21.321Z",

"email" : "bcooper@biglytics.net",

"firstname" : "Bryan",

"hs_object_id" : "251",

"lastmodifieddate" : "2022-03-04T03:08:28.978Z",

"lastname" : "Cooper"

"updatedAt" : "2022-03-04T03:08:28.978Z"

}

But when trying to use batch operations is there a way to retrieve associations in the response. I tried the following but did not work. From API there seems to be no way to achieve this. Is there any other way to do this?

curl --request POST \

--url https://api.hubapi.com/crm/v3/objects/contacts/batch/read \

--header 'authorization: Bearer <token>' \

--header 'content-type: application/json' \

--data '{

"inputs": [

{

"id": "251"

}

"associations": [

"notes"

]

}' | json_pp

% Total % Received % Xferd Average Speed Time Time Time Current

Dload Upload Total Spent Left Speed

100 501 0 415 100 86 335 69 0:00:01 0:00:01 --:--:-- 408

{

"completedAt" : "2022-03-08T06:27:11.024Z",

"results" : [

{

"archived" : false,

"createdAt" : "2022-03-03T09:23:21.321Z",

"id" : "251",

"properties" : {

"createdate" : "2022-03-03T09:23:21.321Z",

"email" : "bcooper@biglytics.net",

"firstname" : "Bryan",

"hs_object_id" : "251",

"lastmodifieddate" : "2022-03-04T03:08:28.978Z",

"lastname" : "Cooper"

"updatedAt" : "2022-03-04T03:08:28.978Z"

}

"startedAt" : "2022-03-08T06:27:10.999Z",

"status" : "COMPLETE"

}

Re: Getting Associations in Batch APIs

dennisedson — Wed, 09 Mar 2022 16:27:17 GMT

@SR36

Have you explored the CRM search api? You can return associations with that

Re: Getting Associations in Batch APIs

SR36 — Wed, 25 May 2022 08:48:08 GMT

Thanks. I ended up using the search API, but this was sub optimal as I already had the list of contacts with ids

Re: Getting Associations in Batch APIs

sfroment — Thu, 25 Aug 2022 08:09:07 GMT

Hey,

@SR36 @dennisedson
How did you return the associations using the search api ?
It seems like many aren't knowing how to do this also https://community.hubspot.com/t5/APIs-Integrations/Get-associations-with-deals-from-crm-objects-deals-search/m-p/321104

Thanks !

Re: Getting Associations in Batch APIs

SR36 — Thu, 06 Oct 2022 12:21:18 GMT

Hi @sfroment ,

I dont think we can get associations via the search API. As a result I had to do this in a sub optimal convoluted way 😞

1) Execute a search query

2) For all returned records, call the batch association API to get the list of associations

3) The returned association is in turn sparse, it does not have the name of the contact, company or deal. So make further batch requests to get these information

This is definitely not ideal. I'm not sure why assocaitions is not exposed in search while its exposed in list API

Re: Getting Associations in Batch APIs

sfroment — Thu, 06 Oct 2022 12:25:24 GMT

Yes indeed it is the solution I also implemented 😞

Re: Getting Associations in Batch APIs

CMarl — Wed, 19 Oct 2022 16:00:31 GMT

@dennisedson it appears we cannot get associations through the search api either. please advise..

Re: Getting Associations in Batch APIs

elephantal — Thu, 21 Nov 2024 16:31:08 GMT

How did you get batch associations from the API? I can't seem to find that functionality. Can only fetch associations one at a time.