topic Re: How to get the deal's associated company name? in APIs & Integrations

How to get the deal's associated company name?

OLIVESHARON — Mon, 29 Aug 2022 08:08:35 GMT

Hi all,

I'm trying to get the deal's associated company name by using the below code.

var http = require("https");

var options = {
"method": "GET",
"hostname": "api.hubapi.com",
"port": null,
"path": "/crm/v4/objects/deal/"+event.inputFields['hs_object_id']+"/associations/company?limit=500",
"headers": {
"accept": "application/json",
"authorization": "access - token"
}
};

var req = http.request(options, function (res) {
var chunks = [];

res.on("data", function (chunk) {
chunks.push(chunk);
});

res.on("end", function () {
var body = Buffer.concat(chunks);
console.log(body);

});
});

req.end();
}

But in the result, I'm getting the record ID of the company which is associated with the deal which is absolutely fine.

Result :

{
"results": [
{
"toObjectId": 98445322,
"associationTypes": [
{
"category": "HUBSPOT_DEFINED",
"typeId": 0,
"label": "string"
}
]
}
],
"paging": {
"next": {
"after": "string",
"link": "string"
}
}

Now is there any possibility to get the 'Company Name' in the result?

Or is there any way to get the 'Company Name' using the record ID of the company which we got in the result?

Thanks in Advance!

Re: How to get the deal's associated company name?

Teun — Mon, 29 Aug 2022 08:22:55 GMT

Hi @OLIVESHARON ,

The association API will only return ID's, so you will need a second API call to get the company name. And yes, you can use the ID you got in the first call to get the company name.

Just make a second call to 'https://api.hubapi.com/crm/v3/objects/companies/<companyID>?archived=false' to retrieve the default properties of the company.

Re: How to get the deal's associated company name?

OLIVESHARON — Mon, 29 Aug 2022 09:39:03 GMT

Hi @Teun,

Thank you very much for the information you provided. That's very helpful and it worked for me to get the default properties of the company.

Also, I would like to know how we can use the record ID which we got in the first call.

For example, below is the result from the first call, and in the result, we can see the record ID of the company. This record ID should be included in the second call to get the company properties. The second URL (https://api.hubapi.com/crm/v3/objects/companies/<companyID>?archived=false) should be dynamic. The company ID here in the URL should be the record ID from the first call result. I'm new to HubSpot and trying to know more. Please let me know if this can be done.

"results": [
{
"toObjectId": 98445322,
"associationTypes": [
{
"category": "HUBSPOT_DEFINED",
"typeId": 0,
"label": "string"
}

Re: How to get the deal's associated company name?

Teun — Mon, 29 Aug 2022 12:53:15 GMT

Hi @OLIVESHARON ,

Here is an example using Axios, I prefer it over https, but should help you out. I'm also using the v3 version of the API:

const axios = require('axios') const associatedCompanies = [] const associatedCompanyIDs = await axios({ method: 'get', url: `https://api.hubapi.com/crm/v3/objects/deals/${event.inputFields['hs_object_id']}/associations/company?limit=500`, headers: { 'Authorization': `Bearer ${token}`, 'Content-Type': 'application/json' } }).then((response) => { console.log(`Retrieved ${response.data.results.length} associated companies for deal: ${event.inputFields['hs_object_id']}`) return response.data.results }).catch((error) => { console.log(`Error while retrieving associated companies for deal ${event.inputFields['hs_object_id']}: ${error.response.data.message}`) return false }) if (associatedCompanyIDs) { const data = { properties: [ 'name', 'domain' ], inputs: associatedCompanyIDs.map((associatedCompanyID) => { return { id: associatedCompanyID.id } }) } associatedCompanies = await axios({ method: 'post', url: `https://api.hubapi.com/crm/v3/objects/companies/batch/read`, headers: { 'Authorization': `Bearer ${token}`, 'Content-Type': 'application/json' }, data: JSON.stringify(data) }).then((response) => { console.log(`Retrieved ${response.data.results.length} associated companies for deal: ${event.inputFields['hs_object_id']}`) return response.data.results }).catch((error) => { console.log(`Error while retrieving associated companies for deal ${event.inputFields['hs_object_id']}: ${error.response.data.message}`) return false }) console.log(associatedCompanies) }

Re: How to get the deal's associated company name?

OLIVESHARON — Mon, 29 Aug 2022 15:35:19 GMT

Hi @Teun,

Thanks a million, the solution helped me to achieve my requirement.