Zum Hauptinhalt springen
GET
/
properties
/
v1
/
deals
/
groups
Get deal property groups
curl --request GET \
  --url https://api.hubapi.com/properties/v1/deals/groups
[
  {
    "name": "<string>",
    "displayName": "<string>",
    "displayOrder": 123,
    "hubspotDefined": true,
    "properties": [
      {
        "name": "<string>",
        "label": "<string>",
        "description": "<string>",
        "groupName": "<string>",
        "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>",
        "hubspotDefined": true,
        "createdAt": 123,
        "updatedAt": 123,
        "createdUserId": 123,
        "updatedUserId": 123
      }
    ]
  }
]

Abfrageparameter

​
includeProperties
boolean

Returns all of the properties for each deal property group.

Antwort

200 - application/json

Successful response with deal property groups

​
name
string

The internal name of the property group

​
displayName
string

The displayed name of the group

​
displayOrder
integer

The order of the group when displaying properties

​
hubspotDefined
boolean

Whether the group is defined by HubSpot

​
properties
object[]

Properties in this group (only included if includeProperties=true)

Zuletzt geändert am 9. April 2026