topic Re: API Search - Return association field in APIs & Integrations

API Search - Return association field

TGrandey — Sat, 29 Apr 2023 23:26:57 GMT

I have a custom object that has an association to HubSpot's company object. I'm wondering if there is a way to have the search api return a property of the company when searching the custom object.

For example, I'm searching for all custom objects with the last name of "Smith" and I would like to return some of the properties of the custom object as well as the name of the company that the custom object is associated with.

Search: last_name EQ Smith
Return:
first_name: Joe

last_name: Smith

company.company_name: Acme, Inc.

Thanks for any help!

Re: API Search - Return association field

himanshurauthan — Mon, 01 May 2023 09:06:16 GMT

Hello @TGrandey

use the Search API to return the associated company property when searching for custom objects in HubSpot. To achieve this, you'll need to specify the "properties" parameter in your API request and include the name of the association property, followed by the name of the company property you wish to return.

Here's an example of what the API request might look like:

https://api.hubapi.com/crm/v3/objects/custom-objects/search?hapikey=<your_api_key>&properties=first_name,last_name,company.association_property_name.company_property_name&q=last_name:Smith

In this example, replace <your_api_key> with your HubSpot API key, custom-objects with the name of your custom object, association_property_name with the name of the association property that links the custom object to the company object, and company_property_name with the name of the company property you want to return.

With this API request, you should be able to retrieve custom objects with the last name of "Smith" and include the associated company's name in the response. Note that you may need to adjust the parameter names and values to match your specific use case.

Re: API Search - Return association field

dca123 — Fri, 27 Oct 2023 02:22:18 GMT

Hi,

Could you simplify this to explain how I can get the associated company name when the custom object is a deal ?

Thank you

Re: API Search - Return association field

SLane1 — Mon, 20 Nov 2023 20:51:13 GMT

Where would one find the 'association_property_name'?