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

Syntax

Connect-HubSpot -LeadPropertiesFile string

Data Type

cstr

Default Value

""

Remarks

Use this property to limit the fields selected from the Leads table, particularly 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: "hs_object_id,hs_lead_name,hs_lead_type").
• The full file path to a text file containing the same list (for example: C:\Users\Public\Documents\customfields.txt).

The field names must match the internal (API) names used by HubSpot. This property is useful when you do not have control over the SQL query projection, such as in business intelligence tools or middleware workflows.

Performance Considerations

Restricting the selected fields improves performance and reduces the risk of API errors caused by large payloads or excessive field counts.