curl --request GET \
--url https://api.hubapi.com/properties/v1/companies/groups[
{
"name": "<string>",
"displayName": "<string>",
"displayOrder": 123,
"hubspotDefined": true,
"properties": [
{
"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>",
"createdUserId": 123,
"updatedUserId": 123
}
]
}
]Returns all of the company property groups for a portal. Property groups are used to organize properties. When viewing company properties in HubSpot, the properties will be sorted by their property group.
curl --request GET \
--url https://api.hubapi.com/properties/v1/companies/groups[
{
"name": "<string>",
"displayName": "<string>",
"displayOrder": 123,
"hubspotDefined": true,
"properties": [
{
"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>",
"createdUserId": 123,
"updatedUserId": 123
}
]
}
]Returns all of the properties for each company property group.
Successful response with company property groups
The internal name of the property group
The displayed name of the group
The order of the group when displaying properties
Whether the group is defined by HubSpot
Properties in this group (only included if includeProperties=true)
Show child attributes