purpose formField and hidden properties of object

Developer Support APIs & Integrations
1

the attribute like hidden or formField is not working properly in api. i have hidden many fields in contact object , but in api response its show true..
or can you explain purpose of hidden and formField ?
or how can i get fields from api, that are only visible in Hubspot UI of contact, deals, tasks etc

2

Hi @fahadxbond :waving_hand:

Thanks for raising this — the way UI visibility settings map (or don’t map) to API responses can definitely be confusing.

I’d like to invite some community members who are subject matter experts in CRM properties and HubSpot APIs to join this conversation.
Hi @Bhupendra_Kumar @GRajput @Ben_M — hope you’re all having a great week! Can you share how the hidden and formField flags are intended to work, and whether there’s a supported way to retrieve only the properties that are visible in the HubSpot UI (for contacts, deals, tasks, etc.)?

Your insights would be greatly appreciated.
Best,
Victor

3

Hi @fahadxbond

Please share the API payload and response so we can review them and provide more accurate assistance.

Thanks!

4

fahadxbond_0-1767109909356.png
fahadxbond_0-1767109909356.png1873×813 114 KB

what are the attribute or flag in api to get this value .. is it “formField”: true or “hidden”: false,
or something else

5

Hi @fahadxbond

To fetch all properties of a HubSpot object, you can use the following cURL request:

curl --request GET \

--url https://api.hubapi.com/properties/v1/<Object_Type>/properties

In the API response, each property includes metadata that indicates whether it is hidden or available as a form field. A sample property object looks like this:

[{"name": "<string>","label": "<string>","description": "<string>","groupName": "<string>","type": "string","fieldType": "textarea","options": [{"description": "<string>","label": "<string>","value": "<string>","displayOrder": 123,"hidden": true,"readOnly": true,"doubleData": 123}],"displayOrder": 123,"formField": true,"readOnlyValue": true,"readOnlyDefinition": true,"hidden": true,"mutableDefinitionNotDeletable": true,"favorited": true,"favoritedOrder": 123,"calculated": true,"externalOptions": true,"displayMode": "<string>","deleted": true,"hubspotDefined": true,"createdAt": 123,"updatedAt": 123,"createdUserId": 123,"updatedUserId": 123} ]

Regarding how these attributes affect the HubSpot UI:

  • Hidden: Determines whether the property is hidden from the HubSpot UI.
  • Form Field: Determines whether the property is available for use in HubSpot forms.
6

pls reply