API | Get properties from a group of a company

MedeirosRodrigo · ‎Feb 4, 2020

Suppouse that we have a company named CompA with companyid 20200204.

This company have a properties group named Invoice Info with a internal name invoice_info.

Inside this group have some Key:Values properties with informations needed to generate a invoice for this company as well.

I want a Get API call to retrieve this "invoice information" something look like:

/properties/v2/companies/20200204/properties?hapikey=myapikeystring&groups=invoice_info

Could sameone help me to accomplish it

WendyGoh · ‎Feb 12, 2020

Hey @MedeirosRodrigo,

Digging further into this, I believe the reason is because the internal value for property "CNPJ" is "cnpj". If we change the POST data to

{"filterGroups":[
{
"filters": [
{
"propertyName": "cnpj",
"operator": "HAS_PROPERTY"
}
]
}
],
"properties": [ "cnpj" ]
}

You should be able to see a 200 response back. Currently it's returning blank because this property isn't used in any company records yet.

Additionally, you can refer to this documentation on how to check property internal value - Manage your properties.

View solution in original post

WendyGoh · ‎Feb 4, 2020

Hey @MedeirosRodrigo,

Just to clarify, are you looking to retrieve companies with the invoice_info property known and the return response will show the value of the invoice_info property?

If so, you can achieve this by using the crm search endpoint - HubSpot Search v3.

Here's an example:

When I POST the following endpoint:

https://api.hubspot.com/crm/v3/objects/companies/search?hapikey={{myhapikey}}

With the following POST body

{
    "filterGroups":[
      {
        "filters": [
          {
            "propertyName": "active_pe",
             "operator": "HAS_PROPERTY"
          }
    ]
  }
],
    "properties": [ "active_pe" ]
}

I retrieve all the companies with the active_pe known and the active_pe property value will be display on my response body.

Let me know if this is what you're looking for and/or if there's any further question on this.

MedeirosRodrigo · ‎Feb 11, 2020

Hi @WendyGoh
Trying through this call

curl --data "@/hs-body.json" https://api.hubspot.com/crm/v3/objects/companies/search?hapikey=<my_api_key>

I received it

<html>

<head>

<title>Error 415 Unsupported Media Type</title>

</head>

<body><h2>HTTP ERROR 415</h2>

<p>Problem accessing /crm/v3/objects/companies/search. Reason:

<pre> Unsupported Media Type</pre></p>

</body>

</html>

----------------------------------------------------------------------------------------------

hs-body.json

{
"filterGroups":[
{
"filters": [
{
"propertyName": "CNPJ",
"operator": "HAS_PROPERTY"
}
]
}
],
"properties": [ "CNPJ" ]
}

------------------------------------------------------------------------------------------

So, I fail again.

What I did wrong?

WendyGoh · ‎Feb 11, 2020

Hey @MedeirosRodrigo,

Are you calling a POST request to the crm search endpoint - HubSpot Search v3?

MedeirosRodrigo · ‎Feb 12, 2020

Yes, I do...

this is my call on terminal:

curl https://api.hubapi.com/crm/v3/objects/companies/search?hapikey=<mytoken> \
--request POST \
--header "Content-Type: application/json" \
--data '{
"filterGroups":[
{
"filters": [
{
"propertyName": "CNPJ",
"operator": "HAS_PROPERTY"
}
]
}
],
"properties": [ "CNPJ" ]
}'

and this is the response received:

{"status":"error","message":"There was a problem with the request.","correlationId":"<token1>","requestId":"<token2>"}

FYI: <tokens> tags is only to keep it safe the actual values

WendyGoh · ‎Feb 12, 2020

Hey @MedeirosRodrigo,

Digging further into this, I believe the reason is because the internal value for property "CNPJ" is "cnpj". If we change the POST data to

{"filterGroups":[
{
"filters": [
{
"propertyName": "cnpj",
"operator": "HAS_PROPERTY"
}
]
}
],
"properties": [ "cnpj" ]
}

You should be able to see a 200 response back. Currently it's returning blank because this property isn't used in any company records yet.

Additionally, you can refer to this documentation on how to check property internal value - Manage your properties.

MedeirosRodrigo · ‎Feb 7, 2020

Thank you @WendyGoh

I'll try it on next week and back to you if worked

APIs & Integrations