API endpoint to retrieve Custom Properties Usages

Develop, Build & Integrate APIs & Integrations
1

When performing a manual export via the HubSpot Web UI, the exported files with all properties, contains information about the usage of those properties:

A property such as Job Title might be used in an Active List to get a full list of Contacts with “marketing” in their title. So that would appear in HubSpot as “used in” showing a link to that list. The export would only show a count of (1) Lists in that column. Properties may also be used in Forms, Reports, Workflows, etc.

But when using the Properties API endpoint, I don’t get said information.

Question: is there any way to get the information about Usages for a Custom property via the API?

Thanks!

2

hi @alva ,

I you want to get the custom fields also you can get them in the api response by inclduing them as query parameter like this

For Example you have custom property job_title in deal then it will be like

`properties=job_title` properties.

i.e. crm/v3/objects/deals?properties=job_title&limit=100&properties=dealstage

3

Thanks but this is not what I mean. I mean the Usages: A property such as Job Title might be used in an Active List to get a full list of Contacts with “marketing” in their title. So that would appear in HubSpot as “used in” showing a link to that list. The export would only show a count of (1) Lists in that column. Properties may also be used in Forms, Reports, Workflows, etc.

4

@alvarofranz

There was no direct API endpoint in the HubSpot API to retrieve the “Usages” information for a specific property. The HubSpot API primarily focused on CRUD (Create, Read, Update, Delete) operations for objects like Contacts, Companies, Deals, etc., and did not expose endpoints to access internal configuration or metadata information, such as property usages.

5

So instead of so many words, the answer is more simple:

“It’s not possible”.

Right? Thanks!

6

Yes