topic All properties for a specific company in APIs & Integrations

All properties for a specific company

BBurdette — Wed, 03 May 2023 18:21:53 GMT

I am evaluating the capabilities of HubSpot API.

At this time I do not see support to request all properties on a specific company...

.../crm/v3/objects/companies/{companyId}

Only name and domain (and meta) are served... but if I request explicit properties...

/crm/v3/objects/companies/{companyId}?properties=industry,city,state,zip

... they are on the company.

How am I supposed to know what properties are currently on a specific company?

Am I to believe I have to include every "potential" property in the whole system in the querystring on every request for each company?

Re: All properties for a specific company

himanshurauthan — Thu, 04 May 2023 09:56:19 GMT

Hello @BBurdette

Based on the HubSpot API documentation, it appears that you can retrieve all the properties for a specific company using the "Get all properties for a Company" endpoint.

The endpoint is:

GET /crm/v3/properties/:objectType

To retrieve all the properties for a specific company, you would replace :objectType with companies, like this:

GET /crm/v3/properties/companies

This endpoint will return a list of all properties for companies, including the name, data type, and other metadata for each property. You can then use this information to determine which properties are available for a specific company and include those in your query.

Alternatively, you can use the "Get a Company by ID" endpoint with the "includePropertyVersions" parameter set to true. This will return all the properties and their values for the specified company, like this:

GET /crm/v3/objects/companies/:companyId?includePropertyVersions=true

This should return all properties and their values for the specified company.
you may have to use pagination to limit the amount of data returned per request.

Re: All properties for a specific company

BBurdette — Thu, 04 May 2023 15:47:33 GMT

Thank you for your response. I am familiar with those endpoints as they led me to post this question.

These requests have the same response...

GET /crm/v3/objects/companies/:companyId GET /crm/v3/objects/companies/:companyId?includePropertyVersions=true

Unfortunately this request is not for a specific company but for ALL companies... "potential properties"

GET /crm/v3/properties/companies

Based on your response, the only way to describe a specific company's properties in full is to send all "potential property" names in the query. For your demo company: 162 "potential properties"

GET /crm/v3/objects/companies/:companyId?properties=name,industry,city,state,zip,....

You have to know the name of the property, if even attached, to view it.

Re: All properties for a specific company

GRajput — Fri, 12 May 2023 10:57:38 GMT

Hi @BBurdette

You are correct that the default response from the `/crm/v3/objects/companies/{companyId}` endpoint only includes a limited set of properties, including the company name, domain, and metadata. To retrieve all properties on a specific company, you can include the `properties=all` query parameter in your request, like this: ``` /crm/v3/objects/companies/{companyId}?properties=all ``` This will return all properties for the specified company, including any custom properties you may have added to your HubSpot account. Alternatively, if you only want to retrieve a specific set of properties for a company, you can include them in the `properties` query parameter, separated by commas, like this: ``` /crm/v3/objects/companies/{companyId}?properties=industry,city,state,zip ``` Regarding your question about knowing what properties are currently on a specific company, you can retrieve a list of all properties for the Company object using the `/crm/v3/properties` endpoint. This will return metadata about each property, including the property name, label, data type, and other information that can help you determine which properties are available to retrieve for a specific company. It is not necessary to include every potential property in the query string on every request for each company. You can choose which properties you want to retrieve based on your specific use case, and include only those properties in your request.

Hope his will helps you out. If you find it helpful, please find it as Solution.

Thanks!