GET
/
properties
/
v1
/
companies
/
groups
Get Company Property Groups
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
      }
    ]
  }
]

Query Parameters

includeProperties
boolean

Returns all of the properties for each company property group.

Response

200 - application/json

Successful response with company property groups

The response is of type object[].