Specifies a comma-separated list or file path containing the names of fields to retrieve for the Goals table.

Syntax

Connect-HubSpot -GoalPropertiesFile string

Data Type

cstr

Default Value

""

Remarks

Use this property to limit the fields selected from the Goals 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: "dealname,amount,description").
• 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 these names from the Name column of the GoalProperties table.

This property is especially useful when working with reporting tools, dashboards, or other systems where direct SQL editing is not possible.

Performance Considerations

Restricting the fields returned can improve performance and reduce response sizes, especially when dealing with goals that include a large number of custom properties. It also helps avoid errors related to API field count or payload size limits.