ContactPropertiesFile Parameter (Connect-HubSpot Cmdlet)
Specifies a comma-separated list or file path containing the names of fields to retrieve for the Contacts table.
Syntax
Connect-HubSpot -ContactPropertiesFile string
Data Type
cstr
Default Value
""
Remarks
Use this property to limit the fields selected from the Contacts table, especially when the number of custom properties may exceed HubSpot's API limits. Attempting to select all fields at once may result in errors.
You can set this property to either:
- A comma-separated list of field names (for example: "firstname,lastname,lastmodifieddate").
- The full file path to a text file containing a comma-separated list of API field names (for example, C:\Users\Public\Documents\customfields.txt).
The field names must match the internal (API) names used by HubSpot. You can retrieve the correct field names from the Name column of the ContactProperties table.
This property is helpful when using business intelligence tools, dashboards, or other systems where you cannot modify the SQL statement directly.
Performance Considerations
Selecting only the fields you need reduces payload size and helps avoid API errors. This improves performance when querying contacts with many custom properties and minimizes the chance of hitting HubSpot's response size or field count limits.