Specifies whether the provider retrieves archived records when querying supported objects.

Syntax

Connect-HubSpot -Archived SwitchParameter

Data Type

bool

Default Value

false

Remarks

This property is only supported when using the HubSpotV3 schema.

When set to true, the cmdlet includes archived records in query results.

When set to false, only unarchived (active) records are retrieved.

This property is useful for accessing historical data or records that were previously deleted or deactivated in the HubSpot UI. Archived records may be relevant for audits, migrations, or data recovery scenarios.

Note: Most HubSpotV3 tables support this property, even if they do not include an Archived column. However, the following tables do not support archived filtering, and this property will have no effect:

• Workflows
• Roles
• Teams
• UserProvisioning
• Folders
• Files
• Campaigns
• All Pipeline tables (DealPipelines, TicketPipelines, etc.)
• All PipelineStages tables (DealPipelineStages, LeadPipelineStages, etc.)
• All PropertyGroups tables (ContactPropertyGroups, CompanyPropertyGroups, etc.)