This appears to have been possible in earlier versions of the API with `includeProperties=true`, but apparently this does not work in v3. The following URL gets me only the group information …
https://api.hubspot.com/crm/v3/properties/contacts/groups/moca-custom?includeProperties=true
The Search API does not work either, since the Search API is limited to objects and does not work with properties.
Is getting properties by group name currently possible?
Thanks!
Hello @beantaxi, Happy Monday!
Thank you for posting in our Community! I wanted to share this API doc with more information about group properties and this doc about getting Contact Property Group Details.
To our top experts @Syeda_Fatima @kaleemmolani any recommendations to @beantaxi matter?
Thank you,
Pam
Hi Pam,
Happy Monday to you as well.
I am familiar with the v3 property endpoints and the v3 doc you linked to.
I don’t see any endpoints there that will do what I want.
The v1 API link is new to me. I’d prefer not to rely on a v1 endpoint,
unless there is a guarantee of long-term support, since I’d rather not have
to track whether or not the v1 endpoint is still available or has been
decommissioned.
Also, in either case, I do not see a documented method for restricting the
amount of property data in response to a request. Being able to restrict
this response data, eg to property names, would be very nice, especially in
the case of enumerations, where the amount of options data might be quite
large but not be of any interest (eg I just want to list property names).
So, I’m still curious if a v1 endpoint which returns fully-populated
properties is truly my best option, or if there is something else.
Thanks!
Hey @PamCotton, thanks for tagged me. I would love to share insightes on @beantaxi concerns.
Hey @beantaxi, I would suggest, it coudnt possible to get properties by group name in the HubSpot API v3. The includeProperties=true parameter is not supported in the GET/crm/v3/properties/contacts/groups/{groupName} endpoint, as stated in the API documentation.
One possible workaround would be to retrieve all the properties for a specific object (e.g., contacts) using the GET /crm/v3/properties/{objectType} endpoint and filter the results based on the groupName property of each property object. However, this may not be efficient if you have a large number of properties.
And another option would be to use the HubSpot API v2, which supports the includeProperties=true parameter in the GET /properties/v1/{objectType}/groups/{groupName} endpoint. However, i would suggest to keep it mind that the HubSpot API v2 has been deprecated and will eventually be replaced by the v3 API, so this may not be a viable long-term solution.
Hope this helps! feel free to get in touch if more help is needed.
Cheers!