topic Re: GET companies and deals more details in the API in APIs & Integrations

GET companies and deals more details in the API

devphoenix — Fri, 24 May 2024 15:13:41 GMT

Hi team,

Could you please help here.

{{baseUrl}}/crm/v3/objects/contacts?associations=companies,deals

in the response of this API, we are getting this...
{
"id": "101",
"properties": {
"createdate": "2023-07-24T08:53:58.795Z",
"email": "gourav.gupta+hs@brevo.com",
"firstname": "Contact",
"hs_object_id": "101",
"lastmodifieddate": "2024-05-22T10:39:17.610Z",
"lastname": "B"
},
"createdAt": "2023-07-24T08:53:58.795Z",
"updatedAt": "2024-05-22T10:39:17.610Z",
"archived": false,
"associations": {
"companies": {
"results": [
{
"id": "20861273154",
"type": "contact_to_company"
},
{
"id": "16682150751",
"type": "contact_to_company_unlabeled"
},
{
"id": "20861273154",
"type": "contact_to_company_unlabeled"
}
]
},
"deals": {
"results": [
{
"id": "19489433890",
"type": "contact_to_deal"
}
]
}
}
}

Is it possible to include more details, such as the names of companies and deals, in the response?

Example response:

json

Copy code

{ "id": "20861273154", "type": "contact_to_company", "name": "Company A" }

If this feature is not currently available, could you please add it to the to-do list? This enhancement would greatly improve our ability to use your APIs more effectively.

Re: GET companies and deals more details in the API

Jaycee_Lewis — Fri, 24 May 2024 16:58:58 GMT

Hey, @devphoenix 👋 This ended up getting flagged by the spam filter. I moved it out, so our community members can take a look.

Talk soon! — Jaycee

Re: GET companies and deals more details in the API

Humashankar — Fri, 24 May 2024 18:38:11 GMT

Hi @devphoenix

HubSpot's Batch Read API enables efficient retrieval of detailed information for multiple objects (companies and deals) by leveraging their IDs. The below steps helps better.

Obtain Association IDs by Extract the association IDs from the initial response, found in the "results" array for companies and deals (e.g., "id": "20861273154").
Construct Batch Read Request by making use of the retrieved association IDs to build a new API call to the Batch Read endpoint (/crm/v3/objects/batch-read). Include the IDs in the request body to fetch comprehensive information for the specified objects in a single, efficient API call, utilizing the full potential of the Batch Read API

If you'd like to see a more streamlined experience, you can also submit a feature request to HubSpot by navigating to Ideas from the dropdown.

Hope this helps - Happy to help further!!
Thank you very much and have a great one!
Warm regards

Re: GET companies and deals more details in the API

Teun — Fri, 24 May 2024 19:53:53 GMT

Hi @devphoenix ,

Using the regular REST API endpoints that HubSpot offers, you will need a second batch API request to retrieve the details of the associated objects. Retrieving associated records through a GET request currently only returns the ID and association label.

However, if you construct a GraphQL query, you should be able to retrieve the properties you are looking for in a single API call.

Re: GET companies and deals more details in the API

devphoenix — Sun, 26 May 2024 15:38:27 GMT

Thank you for the answer! 😊

Could you please share the steps and APIs to achieve this? It will be more effective for me.

Re: GET companies and deals more details in the API

devphoenix — Sun, 26 May 2024 15:43:25 GMT

Thank you for the response, but I am not able to get the information I need. Could you please share the APIs with some examples? This would be very beneficial, and I would appreciate it.

Re: GET companies and deals more details in the API

devphoenix — Mon, 10 Jun 2024 10:11:45 GMT

HI @Teun @Humashankar @Jaycee_Lewis

Thanks for your response, it is possible to have the assoicated object information in these API's,

{{baseUrl}}/crm/v3/objects/companies/16682150751?associations=contacts,deals
like in the response I will get

use {{baseUrl}}/crm/v3/objects/companies/search

"associations": ["deals", "contacts"] will extent with deal name and contact email information

Could you guys please help here.
Thanks

Re: GET companies and deals more details in the API

Humashankar — Mon, 10 Jun 2024 11:49:11 GMT

Hi @devphoenix

Both methods you mentioned can achieve the goal of retrieving associated object information.

Hope this helps - Happy to help further!!

Regards

Re: GET companies and deals more details in the API

devphoenix — Mon, 10 Jun 2024 12:44:29 GMT

@Humashankar, I've been trying hard for the past few days but haven't received the response I mentioned. Could you please share the complete method or CURL? Your help would be greatly appreciated. Thanks in advance!

Re: GET companies and deals more details in the API

Humashankar — Mon, 10 Jun 2024 13:25:08 GMT

Hi @devphoenix

Retrieve company data with nested includes,

GET {{baseUrl}}/crm/v3/objects/companies/16682150751?associations=contacts(id,email),deals(id,dealname)

This API request fetches information about the company with ID 16682150751, including:

Contacts - ID and email address
Deals - ID and deal name

Believing the "email" and "dealname" properties exist.

Can you try and get us with the outcome - will see how we can fix this.

Regards

Re: GET companies and deals more details in the API

devphoenix — Mon, 10 Jun 2024 16:55:08 GMT

Thanks @Humashankar for being so helpful.

But it didn't worked out.

Could you please help more here !!

and with {{baseUrl}}/crm/v3/objects/companies/search

"associations": ["deals", "contacts"] how to pass these in the body of the CURL?

Thanks

Re: GET companies and deals more details in the API

Humashankar — Mon, 10 Jun 2024 17:19:31 GMT

Hi @devphoenix

The "associations": ["deals", "contacts"] section should be included within the JSON request body, not as a separate parameter in the URL
Can you try the below one and give a try-

curl -X POST \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"filterGroups": [
{ "filters": [ { "propertyName": "name", "operator": "EQ", "value": "Company Name" } ] } ### Replace "Company Name" with your search criteria
],
"associations": ["deals", "contacts"]
}' \
"{{baseUrl}}/crm/v3/objects/companies/search"

Regards

Re: GET companies and deals more details in the API

devphoenix — Mon, 10 Jun 2024 17:41:20 GMT

@Humashankar Don't worked out this one too.

search API curl

url --location 'https://api.hubapi.com/crm/v3/objects/companies/search' \

--header 'Content-Type: application/json' \

--header 'Accept: application/json' \

--header 'Authorization: Bearer {{key}}' \

--data '{

"filterGroups": [

{

"filters": [

{

"propertyName": "hs_lastmodifieddate",

"operator": "GT",

"value": "1980-06-10T00:00:00.000Z"

}

]

}

"associations": [

"deals",

"contacts"

]

}'

Companies API

curl --location 'https://api.hubapi.com/crm/v3/objects/companies/16682150262?properties=name%2Cindustry%2Cnumberofemployees%2Chubspot_owner_id%2Cphone%2Cannualrevenue%2Cdomain&associations=contacts(id%2Cemail)' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{key}}'

"It would be very helpful if these APIs work as expected, allowing me to retrieve the necessary details, including the associated contact ID and email, as well as the associated deal ID and deal name."