Within deal properties, we have custom made property called Basic features and have some information in it. How can I extract basic features by all deals from an API? I intent to count the number of times a partcilar property appears in that custom created property.
Welcome, @latika_karnani.
You can use the Get all deals endpoint and include properties=responds_to_reviews in the query string so that all deals returned will include data for your Basic Features property.
Please note that “Deals that do not have a value set for a property will not include that property, even when you specify the property.”
By including the limit=250 parameter in your query string, you can retrieve up to 250 deals per call. Depending on how many deals you have in your account, you may have to make multiple calls to retrieve them all.
Hi Issac,
This was very helpful. I am able to get properties from the main Deals information. But not from Features checklist.
Ex.
This is returning results
properties=subscription_type&properties=dealname
But this is not
properties=widget_displayed_on_profile&properties=dealname
Can you tell what I could be doing wrong? Subscription type property is under Deal information and Widget_displayed property is under Featured checklist.
I am aware that property will be returned only for deals where it is filled in Hubspot and I checked the cooresponding record in the API results. There is no result for Widget_displayed
Also this returns only 250 deals. We have over 400. How can I get information from all? Or is there a way I can get results in the URI itself for example where subscription_type=pro
Hi, @latika_karnani.
Glad I could help!
For the Get all deals endpoint, the properties parameter only accepts the internal names of deal properties. Looking in your account, there are no deal properties with the internal name widget_displayed_on_profile. See the screenshot below:
It sounds like you may be trying to filter on the options under a specific deal property, but this is not possible with the properties parameter.
You must retrieve all deals with a known value for the desired deal property and then sort through the results for the specific option values you wish to find on your end.
Per my last message, you can only retrieve up to 250 deals per call. If you have more than 250, you will have to make additional calls to the endpoint using the offset parameter in your query string.
For example, you can get the first 250 deals by querying /deals/v1/deal/paged?limit=250. If the hasMore parameter returned is true, then you will take the offset value and append it to your second call to get the next 250 deals by calling /deals/v1/deal/paged?limit=250&offset={offset_value}.
This is awesome. Perfectly working. Thank you very much.
Hi Isaac,
I have read a number of your posts re APIs and custom fields and was wondering if you could help me.
I am a little new to this…so please forgive any ignorance on my part
I have been using the below to pull out deal information, which has all worked fine, but when i have tried to pull out custom deal properties ie by adding &properties=year_end it ignores the year end of the deal.
The custom field exists in deal information and the year_end parameter is correct.
Is there another conidition i need to add to deal with custom fields?
Would appreciate any help,
Thanks
Welcome, @James23.
Happy to clarify.
It looks like you’ve set up everything correctly… Of the 250 deals returned from that request URL with offset=587705198, I see 62 deals which have known values for the year_end property. These include deal 670209721, which has the value March, and deal 670222221, which has the value July.
Is it possible you’re looking at deals which do not have values for year_end? Per the note in this article:
“Deals that do not have a value set for a property will not include that property, even when you specify the property. A deal without a value for the dealname property would not show the dealname property in the results, even with &properties=dealname in the URL.”
Hi Isaac,
Thanks for getting back to me and confirming that what I had set up was correct.
I have found the fault - apologies
I am using PowerBi and I needed to ‘Load more’ when before I expanded the properties column.
Thanks for the help
James
Glad to hear you found a solution, @JamesHallewell!
Hi !
I’m trying to pull all properties from the deals module, but the custom ones are not working. For this url: “https://api.hubapi.com/deals/v1/deal/paged?includeAssociations=true&limit=2&properties=closedate&properties=part_number&properties=dealstage&properties=hubspot_owner_id&properties=amount
&properties=dealname&properties=createdate&properties=pipeline&properties=estimated_close_date&properties=erp_rep&properties=sodetailid&properties=channel&properties=qt9_id” it’s just bringing these:
