User

List the connected portal's contact properties for the field-mapping wizard step

Answers the HubSpot contact properties the wizard's mapping dropdowns list - standard and custom alike, each as a value/label/type entry - together with the mapping the wizard starts from. An optional search_term filters the list to properties whose label or value contains it. Requires integration-hubspot, account-administrator and a connected portal.

get/api/integration/hubspot/contact-properties

Request

Query parameters

search_termstring

Filters the returned properties to those whose label or value contains this text

Response

The portal's contact properties and the default mapping.

Example response

{
  "properties": [
    {
      "value": "jobtitle",
      "label": "Job Title",
      "type": "string"
    }
  ],
  "default_mappings": {
    "first_name": "firstname",
    "last_name": "lastname",
    "email": "email",
    "title": "jobtitle",
    "phone": "phone",
    "company": "company",
    "linkedin_url": "linkedin_url",
    "location": "location",
    "category": "su_category",
    "subcategory": "su_subcategory"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.