Skip to main content
GET
/
properties
/
v1
/
contacts
/
groups
Get Contact Property Groups
curl --request GET \
  --url https://api.hubapi.com/properties/v1/contacts/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>",
        "deleted": true,
        "hubspotDefined": true,
        "createdAt": 123,
        "updatedAt": 123,
        "createdUserId": 123,
        "updatedUserId": 123
      }
    ]
  }
]

Query Parameters

includeProperties
boolean

Returns all of the properties for each contact property group.

Response

200 - application/json

Successful response with contact 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)