--- title: "POST /crm/lists/2026-09" method: POST path: "/crm/lists/2026-09" tags: ["Basic"] --- # POST /crm/lists/2026-09 `POST /crm/lists/2026-09` ## Request body - ListCreateRequest - `customProperties` object — The list of custom properties to tie to the list. Custom property name is the key, the value is the value. - `filterBranch` union — Filter branch object containing filtering criteria for the list - PublicOrFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine the filters within the branch (OR). - `filterBranchType` 'OR', required — The type of the filter branch (OR). - `filterBranches` union[], required - union - PublicOrFilterBranch — recursive - PublicAndFilterBranch - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'AND', required — Type of filter branch (AND) - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — The operator used to combine filters within the branch (NOT_ALL). - `filterBranchType` 'NOT_ALL', required — The type of the filter branch (NOT_ALL). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Specifies the logical operator used to combine filters within the branch (NOT_ANY). - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch (NOT_ANY). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the restricted filter branch. - `filterBranchType` 'RESTRICTED', required — Specifies the type of the filter branch (RESTRICTED). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string, required — The identifier for the type of event associated with the filter branch. - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch (AND). - `filterBranchType` 'UNIFIED_EVENTS', required — The type of the filter branch (UNIFIED_EVENTS). - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Defines the operation to be applied within the filter branch (HAS_COMPLETED, HAS_NOT_COMPLETED). - `pruningRefineBy` union - … - PublicPropertyAssociationFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch. - `filterBranchType` 'PROPERTY_ASSOCIATION', required — The type of the filter branch (PROPERTY_ASSOCIATION). - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property that is associated with the object ID in the filter branch. - PublicAssociationFilterBranch - `associationCategory` string, required — Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — Type id of the association - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'ASSOCIATION', required — Type of the filter branch (ASSOCIATION) - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `filters` union[], required - union - PublicPropertyFilter - `filterType` 'PROPERTY', required — Indicates that the filter (PROPERTY). - `operation` union, required — Defines the operation to be performed on the property, such as comparison or value matching. - … - `property` string, required — Specifies the name of the property that the filter is applied to. - PublicAssociationInListFilter - `associationCategory` string, required — Defines the category of the association, such as (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'ASSOCIATION', required — Indicates the type of filter being applied, which is 'ASSOCIATION' by default. - `listId` string, required — The ID of the list used in the association filter. - `operator` string, required — Specifies the operation to be performed by the filter, such as 'IN_LIST' or 'NOT_IN_LIST'. - `toObjectType` string — The type of object that the association filter is targeting. - `toObjectTypeId` string — The ID representing the type of object that the association filter is targeting. - PublicPageViewAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `enableTracking` boolean — Indicates whether tracking is enabled for the page view. - `filterType` 'PAGE_VIEW', required — Indicates the type of filter being applied (PAGE_VIEW). - `operator` string, required — Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS). - `pageUrl` string, required — The URL of the page to be used in the filter. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicCtaAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `ctaName` string, required — The name of the Call-to-Action (CTA) to be used in the filter. - `filterType` 'CTA', required — Indicates the type of filter being applied, which is (CTA). - `operator` string, required — Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicEventAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the event filter by coalescing. - … - `eventId` string, required — The ID of the event to be used in the filter. - `filterType` 'EVENT', required — Indicates the type of filter being applied (EVENT). - `operator` string, required — Defines the operation to be applied within the event filter (HAS_EVENT, NOT_HAS_EVENT). - `pruningRefineBy` union — Specifies the criteria for refining the event filter by pruning. - … - PublicFormSubmissionFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION', required — Indicates the type of filter (FORM_SUBMISSION). - `formId` string — The ID of the form used in the filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be performed (FILLED_OUT, NOT_FILLED_OUT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicFormSubmissionOnPageFilter - `coalescingRefineBy` union — Defines the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION_ON_PAGE', required — Indicates the type of filter (FORM_SUBMISSION_ON_PAGE). - `formId` string — The ID of the form associated with the submission filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT). - `pageId` string, required — The ID of the page where the form submission occurred. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicIntegrationEventFilter - `eventTypeId` integer, required — The ID representing the type of event for the integration event filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'INTEGRATION_EVENT', required — Indicates the type of filter (INTEGRATION_EVENT). - PublicEmailSubscriptionFilter - `acceptedStatuses` string[], required - `filterType` 'EMAIL_SUBSCRIPTION', required — Indicates the type of filter (EMAIL_SUBSCRIPTION). - `subscriptionIds` string[], required - `subscriptionType` string — The type of subscription related to the filter (PORTAL, BRAND, SUBSCRIPTION, HARDBOUNCE, SPAMREPORT). - PublicCommunicationSubscriptionFilter - `acceptedOptStates` string[], required - `businessUnitId` string — The ID of the business unit associated with the subscription filter. - `channel` string, required — Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS). - `filterType` 'COMMUNICATION_SUBSCRIPTION', required — Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION) - `subscriptionIds` string[], required - `subscriptionType` string, required — Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION) - PublicCampaignInfluencedFilter - `campaignId` string, required — The ID of the campaign that influences the filter. - `filterType` 'CAMPAIGN_INFLUENCED', required — Indicates the type of filter (CAMPAIGN_INFLUENCED). - PublicSurveyMonkeyFilter - `filterType` 'SURVEY_MONKEY', required — Indicates the type of filter being applied (SURVEY_MONKEY). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_RESPONDED_TO_SURVEY, HAS_NOT_RESPONDED_TO_SURVEY). - `surveyId` string, required — The ID of the survey associated with the filter. - PublicSurveyMonkeyValueFilter - `filterType` 'SURVEY_MONKEY_VALUE', required — Defines the type of filter (SURVEY_MONKEY_VALUE). - `operator` string, required — Defines the operation to be applied within the filter (HAS_ANSWERED_SURVEY_QUESTION_WITH_VALUE). - `surveyAnswerColId` string — The column ID of the survey answer used in the filter. - `surveyAnswerRowId` string — The row ID of the survey answer used in the filter. - `surveyId` string, required — The ID of the survey used in the filter. - `surveyQuestion` string, required — The question from the survey used in the filter. - `valueComparison` union, required — Specifies the operation used to compare the survey answer value. - … - PublicWebinarFilter - `filterType` 'WEBINAR', required — Indicates the type of filter, (WEBINAR). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_WEBINAR_REGISTRATION, NOT_HAS_WEBINAR_REGISTRATION, HAS_WEBINAR_ATTENDANCE, NOT_HAS_WEBINAR_ATTENDANCE). - `webinarId` string — The ID of the webinar associated with the filter. - PublicEmailEventFilter - `appId` string, required — The ID of the application associated with the email event filter. - `clickUrl` string — The URL that was clicked in the email event. - `emailId` string, required — The ID of the email associated with the event filter. - `filterType` 'EMAIL_EVENT', required — Indicates the type of filter (EMAIL_EVENT). - `level` string, required — Specifies the level of the email event, such as EMAIL_API_CAMPAIGN_GROUP. - `operator` 'BOUNCED' | 'LINK_CLICKED' | 'MARKED_SPAM' | 'OPENED' | 'OPENED_BUT_LINK_NOT_CLICKED' | 'OPENED_BUT_NOT_REPLIED' | 'RECEIVED' | 'RECEIVED_BUT_NOT_OPENED' | 'REPLIED' | 'SENT' | 'SENT_BUT_LINK_NOT_CLICKED' | 'SENT_BUT_NOT_RECEIVED' | 'UNSUBSCRIBED', required — Defines the operation to be applied within the filter (BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPrivacyAnalyticsFilter - `filterType` 'PRIVACY', required — Specifies the type of filter (PRIVACY). - `operator` string, required — Defines the operation to be applied within the filter (PRIVACY_CONSENT_GRANTED, PRIVACY_CONSENT_NOT_GRANTED). - `privacyName` string, required — The name of the privacy setting used in the filter. - PublicAdsSearchFilter - `adNetwork` string, required — Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL) - `entityType` string, required — Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN) - `filterType` 'ADS_SEARCH', required — Type of the filter (ADS_SEARCH) - `operator` string, required — Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN) - `searchTermType` string, required — Search term to match an ad - `searchTerms` string[], required - PublicAdsTimeFilter - `filterType` 'ADS_TIME', required — Filter type (ADS_TIME) - `pruningRefineBy` union, required — Refinement criteria - … - PublicInListFilter - `filterType` 'IN_LIST', required — Indicates the type of filter being applied (IN_LIST). - `listId` string, required — The ID of the list used in the association filter. - `metadata` PublicInListFilterMetadata - … - `operator` string, required — Specifies the operation to be performed by the filter (IN_LIST, NOT_IN_LIST). - PublicNumAssociationsFilter - `associationCategory` string, required — Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'NUM_ASSOCIATIONS', required — Indicates the type of filter being applied (NUM_ASSOCIATIONS). - PublicUnifiedEventsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string — The identifier for the type of event in the unified events filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'UNIFIED_EVENTS', required — Indicates the type of filter being applied (UNIFIED_EVENTS). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPropertyAssociationInListFilter - `coalescingRefineBy` union, required — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'PROPERTY_ASSOCIATION', required — Indicates the type of filter being applied (PROPERTY_ASSOCIATION). - `listId` string, required — The ID of the list used in the property association filter. - `operator` string, required — Defines the operation to be applied by the filter (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property associated with the object ID in the filter. - `toObjectTypeId` string — The ID representing the type of object that the property association filter is targeting. - PublicConstantFilter - `filterType` 'CONSTANT', required — Specifies the type of filter, which is (CONSTANT). - `shouldAccept` boolean, required — Indicates whether the filter should accept the condition. - `source` string — Defines the source of the constant filter. - PublicAndFilterBranch - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'AND', required — Type of filter branch (AND) - `filterBranches` union[], required - union - PublicOrFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine the filters within the branch (OR). - `filterBranchType` 'OR', required — The type of the filter branch (OR). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch — recursive - PublicNotAllFilterBranch - `filterBranchOperator` string, required — The operator used to combine filters within the branch (NOT_ALL). - `filterBranchType` 'NOT_ALL', required — The type of the filter branch (NOT_ALL). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Specifies the logical operator used to combine filters within the branch (NOT_ANY). - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch (NOT_ANY). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the restricted filter branch. - `filterBranchType` 'RESTRICTED', required — Specifies the type of the filter branch (RESTRICTED). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string, required — The identifier for the type of event associated with the filter branch. - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch (AND). - `filterBranchType` 'UNIFIED_EVENTS', required — The type of the filter branch (UNIFIED_EVENTS). - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Defines the operation to be applied within the filter branch (HAS_COMPLETED, HAS_NOT_COMPLETED). - `pruningRefineBy` union - … - PublicPropertyAssociationFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch. - `filterBranchType` 'PROPERTY_ASSOCIATION', required — The type of the filter branch (PROPERTY_ASSOCIATION). - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property that is associated with the object ID in the filter branch. - PublicAssociationFilterBranch - `associationCategory` string, required — Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — Type id of the association - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'ASSOCIATION', required — Type of the filter branch (ASSOCIATION) - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `filters` union[], required - union - PublicPropertyFilter - `filterType` 'PROPERTY', required — Indicates that the filter (PROPERTY). - `operation` union, required — Defines the operation to be performed on the property, such as comparison or value matching. - … - `property` string, required — Specifies the name of the property that the filter is applied to. - PublicAssociationInListFilter - `associationCategory` string, required — Defines the category of the association, such as (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'ASSOCIATION', required — Indicates the type of filter being applied, which is 'ASSOCIATION' by default. - `listId` string, required — The ID of the list used in the association filter. - `operator` string, required — Specifies the operation to be performed by the filter, such as 'IN_LIST' or 'NOT_IN_LIST'. - `toObjectType` string — The type of object that the association filter is targeting. - `toObjectTypeId` string — The ID representing the type of object that the association filter is targeting. - PublicPageViewAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `enableTracking` boolean — Indicates whether tracking is enabled for the page view. - `filterType` 'PAGE_VIEW', required — Indicates the type of filter being applied (PAGE_VIEW). - `operator` string, required — Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS). - `pageUrl` string, required — The URL of the page to be used in the filter. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicCtaAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `ctaName` string, required — The name of the Call-to-Action (CTA) to be used in the filter. - `filterType` 'CTA', required — Indicates the type of filter being applied, which is (CTA). - `operator` string, required — Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicEventAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the event filter by coalescing. - … - `eventId` string, required — The ID of the event to be used in the filter. - `filterType` 'EVENT', required — Indicates the type of filter being applied (EVENT). - `operator` string, required — Defines the operation to be applied within the event filter (HAS_EVENT, NOT_HAS_EVENT). - `pruningRefineBy` union — Specifies the criteria for refining the event filter by pruning. - … - PublicFormSubmissionFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION', required — Indicates the type of filter (FORM_SUBMISSION). - `formId` string — The ID of the form used in the filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be performed (FILLED_OUT, NOT_FILLED_OUT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicFormSubmissionOnPageFilter - `coalescingRefineBy` union — Defines the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION_ON_PAGE', required — Indicates the type of filter (FORM_SUBMISSION_ON_PAGE). - `formId` string — The ID of the form associated with the submission filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT). - `pageId` string, required — The ID of the page where the form submission occurred. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicIntegrationEventFilter - `eventTypeId` integer, required — The ID representing the type of event for the integration event filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'INTEGRATION_EVENT', required — Indicates the type of filter (INTEGRATION_EVENT). - PublicEmailSubscriptionFilter - `acceptedStatuses` string[], required - `filterType` 'EMAIL_SUBSCRIPTION', required — Indicates the type of filter (EMAIL_SUBSCRIPTION). - `subscriptionIds` string[], required - `subscriptionType` string — The type of subscription related to the filter (PORTAL, BRAND, SUBSCRIPTION, HARDBOUNCE, SPAMREPORT). - PublicCommunicationSubscriptionFilter - `acceptedOptStates` string[], required - `businessUnitId` string — The ID of the business unit associated with the subscription filter. - `channel` string, required — Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS). - `filterType` 'COMMUNICATION_SUBSCRIPTION', required — Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION) - `subscriptionIds` string[], required - `subscriptionType` string, required — Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION) - PublicCampaignInfluencedFilter - `campaignId` string, required — The ID of the campaign that influences the filter. - `filterType` 'CAMPAIGN_INFLUENCED', required — Indicates the type of filter (CAMPAIGN_INFLUENCED). - PublicSurveyMonkeyFilter - `filterType` 'SURVEY_MONKEY', required — Indicates the type of filter being applied (SURVEY_MONKEY). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_RESPONDED_TO_SURVEY, HAS_NOT_RESPONDED_TO_SURVEY). - `surveyId` string, required — The ID of the survey associated with the filter. - PublicSurveyMonkeyValueFilter - `filterType` 'SURVEY_MONKEY_VALUE', required — Defines the type of filter (SURVEY_MONKEY_VALUE). - `operator` string, required — Defines the operation to be applied within the filter (HAS_ANSWERED_SURVEY_QUESTION_WITH_VALUE). - `surveyAnswerColId` string — The column ID of the survey answer used in the filter. - `surveyAnswerRowId` string — The row ID of the survey answer used in the filter. - `surveyId` string, required — The ID of the survey used in the filter. - `surveyQuestion` string, required — The question from the survey used in the filter. - `valueComparison` union, required — Specifies the operation used to compare the survey answer value. - … - PublicWebinarFilter - `filterType` 'WEBINAR', required — Indicates the type of filter, (WEBINAR). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_WEBINAR_REGISTRATION, NOT_HAS_WEBINAR_REGISTRATION, HAS_WEBINAR_ATTENDANCE, NOT_HAS_WEBINAR_ATTENDANCE). - `webinarId` string — The ID of the webinar associated with the filter. - PublicEmailEventFilter - `appId` string, required — The ID of the application associated with the email event filter. - `clickUrl` string — The URL that was clicked in the email event. - `emailId` string, required — The ID of the email associated with the event filter. - `filterType` 'EMAIL_EVENT', required — Indicates the type of filter (EMAIL_EVENT). - `level` string, required — Specifies the level of the email event, such as EMAIL_API_CAMPAIGN_GROUP. - `operator` 'BOUNCED' | 'LINK_CLICKED' | 'MARKED_SPAM' | 'OPENED' | 'OPENED_BUT_LINK_NOT_CLICKED' | 'OPENED_BUT_NOT_REPLIED' | 'RECEIVED' | 'RECEIVED_BUT_NOT_OPENED' | 'REPLIED' | 'SENT' | 'SENT_BUT_LINK_NOT_CLICKED' | 'SENT_BUT_NOT_RECEIVED' | 'UNSUBSCRIBED', required — Defines the operation to be applied within the filter (BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPrivacyAnalyticsFilter - `filterType` 'PRIVACY', required — Specifies the type of filter (PRIVACY). - `operator` string, required — Defines the operation to be applied within the filter (PRIVACY_CONSENT_GRANTED, PRIVACY_CONSENT_NOT_GRANTED). - `privacyName` string, required — The name of the privacy setting used in the filter. - PublicAdsSearchFilter - `adNetwork` string, required — Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL) - `entityType` string, required — Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN) - `filterType` 'ADS_SEARCH', required — Type of the filter (ADS_SEARCH) - `operator` string, required — Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN) - `searchTermType` string, required — Search term to match an ad - `searchTerms` string[], required - PublicAdsTimeFilter - `filterType` 'ADS_TIME', required — Filter type (ADS_TIME) - `pruningRefineBy` union, required — Refinement criteria - … - PublicInListFilter - `filterType` 'IN_LIST', required — Indicates the type of filter being applied (IN_LIST). - `listId` string, required — The ID of the list used in the association filter. - `metadata` PublicInListFilterMetadata - … - `operator` string, required — Specifies the operation to be performed by the filter (IN_LIST, NOT_IN_LIST). - PublicNumAssociationsFilter - `associationCategory` string, required — Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'NUM_ASSOCIATIONS', required — Indicates the type of filter being applied (NUM_ASSOCIATIONS). - PublicUnifiedEventsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string — The identifier for the type of event in the unified events filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'UNIFIED_EVENTS', required — Indicates the type of filter being applied (UNIFIED_EVENTS). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPropertyAssociationInListFilter - `coalescingRefineBy` union, required — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'PROPERTY_ASSOCIATION', required — Indicates the type of filter being applied (PROPERTY_ASSOCIATION). - `listId` string, required — The ID of the list used in the property association filter. - `operator` string, required — Defines the operation to be applied by the filter (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property associated with the object ID in the filter. - `toObjectTypeId` string — The ID representing the type of object that the property association filter is targeting. - PublicConstantFilter - `filterType` 'CONSTANT', required — Specifies the type of filter, which is (CONSTANT). - `shouldAccept` boolean, required — Indicates whether the filter should accept the condition. - `source` string — Defines the source of the constant filter. - PublicNotAllFilterBranch - `filterBranchOperator` string, required — The operator used to combine filters within the branch (NOT_ALL). - `filterBranchType` 'NOT_ALL', required — The type of the filter branch (NOT_ALL). - `filterBranches` union[], required - union - PublicOrFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine the filters within the branch (OR). - `filterBranchType` 'OR', required — The type of the filter branch (OR). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'AND', required — Type of filter branch (AND) - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch — recursive - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Specifies the logical operator used to combine filters within the branch (NOT_ANY). - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch (NOT_ANY). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the restricted filter branch. - `filterBranchType` 'RESTRICTED', required — Specifies the type of the filter branch (RESTRICTED). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string, required — The identifier for the type of event associated with the filter branch. - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch (AND). - `filterBranchType` 'UNIFIED_EVENTS', required — The type of the filter branch (UNIFIED_EVENTS). - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Defines the operation to be applied within the filter branch (HAS_COMPLETED, HAS_NOT_COMPLETED). - `pruningRefineBy` union - … - PublicPropertyAssociationFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch. - `filterBranchType` 'PROPERTY_ASSOCIATION', required — The type of the filter branch (PROPERTY_ASSOCIATION). - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property that is associated with the object ID in the filter branch. - PublicAssociationFilterBranch - `associationCategory` string, required — Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — Type id of the association - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'ASSOCIATION', required — Type of the filter branch (ASSOCIATION) - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `filters` union[], required - union - PublicPropertyFilter - `filterType` 'PROPERTY', required — Indicates that the filter (PROPERTY). - `operation` union, required — Defines the operation to be performed on the property, such as comparison or value matching. - … - `property` string, required — Specifies the name of the property that the filter is applied to. - PublicAssociationInListFilter - `associationCategory` string, required — Defines the category of the association, such as (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'ASSOCIATION', required — Indicates the type of filter being applied, which is 'ASSOCIATION' by default. - `listId` string, required — The ID of the list used in the association filter. - `operator` string, required — Specifies the operation to be performed by the filter, such as 'IN_LIST' or 'NOT_IN_LIST'. - `toObjectType` string — The type of object that the association filter is targeting. - `toObjectTypeId` string — The ID representing the type of object that the association filter is targeting. - PublicPageViewAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `enableTracking` boolean — Indicates whether tracking is enabled for the page view. - `filterType` 'PAGE_VIEW', required — Indicates the type of filter being applied (PAGE_VIEW). - `operator` string, required — Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS). - `pageUrl` string, required — The URL of the page to be used in the filter. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicCtaAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `ctaName` string, required — The name of the Call-to-Action (CTA) to be used in the filter. - `filterType` 'CTA', required — Indicates the type of filter being applied, which is (CTA). - `operator` string, required — Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicEventAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the event filter by coalescing. - … - `eventId` string, required — The ID of the event to be used in the filter. - `filterType` 'EVENT', required — Indicates the type of filter being applied (EVENT). - `operator` string, required — Defines the operation to be applied within the event filter (HAS_EVENT, NOT_HAS_EVENT). - `pruningRefineBy` union — Specifies the criteria for refining the event filter by pruning. - … - PublicFormSubmissionFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION', required — Indicates the type of filter (FORM_SUBMISSION). - `formId` string — The ID of the form used in the filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be performed (FILLED_OUT, NOT_FILLED_OUT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicFormSubmissionOnPageFilter - `coalescingRefineBy` union — Defines the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION_ON_PAGE', required — Indicates the type of filter (FORM_SUBMISSION_ON_PAGE). - `formId` string — The ID of the form associated with the submission filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT). - `pageId` string, required — The ID of the page where the form submission occurred. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicIntegrationEventFilter - `eventTypeId` integer, required — The ID representing the type of event for the integration event filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'INTEGRATION_EVENT', required — Indicates the type of filter (INTEGRATION_EVENT). - PublicEmailSubscriptionFilter - `acceptedStatuses` string[], required - `filterType` 'EMAIL_SUBSCRIPTION', required — Indicates the type of filter (EMAIL_SUBSCRIPTION). - `subscriptionIds` string[], required - `subscriptionType` string — The type of subscription related to the filter (PORTAL, BRAND, SUBSCRIPTION, HARDBOUNCE, SPAMREPORT). - PublicCommunicationSubscriptionFilter - `acceptedOptStates` string[], required - `businessUnitId` string — The ID of the business unit associated with the subscription filter. - `channel` string, required — Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS). - `filterType` 'COMMUNICATION_SUBSCRIPTION', required — Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION) - `subscriptionIds` string[], required - `subscriptionType` string, required — Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION) - PublicCampaignInfluencedFilter - `campaignId` string, required — The ID of the campaign that influences the filter. - `filterType` 'CAMPAIGN_INFLUENCED', required — Indicates the type of filter (CAMPAIGN_INFLUENCED). - PublicSurveyMonkeyFilter - `filterType` 'SURVEY_MONKEY', required — Indicates the type of filter being applied (SURVEY_MONKEY). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_RESPONDED_TO_SURVEY, HAS_NOT_RESPONDED_TO_SURVEY). - `surveyId` string, required — The ID of the survey associated with the filter. - PublicSurveyMonkeyValueFilter - `filterType` 'SURVEY_MONKEY_VALUE', required — Defines the type of filter (SURVEY_MONKEY_VALUE). - `operator` string, required — Defines the operation to be applied within the filter (HAS_ANSWERED_SURVEY_QUESTION_WITH_VALUE). - `surveyAnswerColId` string — The column ID of the survey answer used in the filter. - `surveyAnswerRowId` string — The row ID of the survey answer used in the filter. - `surveyId` string, required — The ID of the survey used in the filter. - `surveyQuestion` string, required — The question from the survey used in the filter. - `valueComparison` union, required — Specifies the operation used to compare the survey answer value. - … - PublicWebinarFilter - `filterType` 'WEBINAR', required — Indicates the type of filter, (WEBINAR). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_WEBINAR_REGISTRATION, NOT_HAS_WEBINAR_REGISTRATION, HAS_WEBINAR_ATTENDANCE, NOT_HAS_WEBINAR_ATTENDANCE). - `webinarId` string — The ID of the webinar associated with the filter. - PublicEmailEventFilter - `appId` string, required — The ID of the application associated with the email event filter. - `clickUrl` string — The URL that was clicked in the email event. - `emailId` string, required — The ID of the email associated with the event filter. - `filterType` 'EMAIL_EVENT', required — Indicates the type of filter (EMAIL_EVENT). - `level` string, required — Specifies the level of the email event, such as EMAIL_API_CAMPAIGN_GROUP. - `operator` 'BOUNCED' | 'LINK_CLICKED' | 'MARKED_SPAM' | 'OPENED' | 'OPENED_BUT_LINK_NOT_CLICKED' | 'OPENED_BUT_NOT_REPLIED' | 'RECEIVED' | 'RECEIVED_BUT_NOT_OPENED' | 'REPLIED' | 'SENT' | 'SENT_BUT_LINK_NOT_CLICKED' | 'SENT_BUT_NOT_RECEIVED' | 'UNSUBSCRIBED', required — Defines the operation to be applied within the filter (BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPrivacyAnalyticsFilter - `filterType` 'PRIVACY', required — Specifies the type of filter (PRIVACY). - `operator` string, required — Defines the operation to be applied within the filter (PRIVACY_CONSENT_GRANTED, PRIVACY_CONSENT_NOT_GRANTED). - `privacyName` string, required — The name of the privacy setting used in the filter. - PublicAdsSearchFilter - `adNetwork` string, required — Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL) - `entityType` string, required — Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN) - `filterType` 'ADS_SEARCH', required — Type of the filter (ADS_SEARCH) - `operator` string, required — Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN) - `searchTermType` string, required — Search term to match an ad - `searchTerms` string[], required - PublicAdsTimeFilter - `filterType` 'ADS_TIME', required — Filter type (ADS_TIME) - `pruningRefineBy` union, required — Refinement criteria - … - PublicInListFilter - `filterType` 'IN_LIST', required — Indicates the type of filter being applied (IN_LIST). - `listId` string, required — The ID of the list used in the association filter. - `metadata` PublicInListFilterMetadata - … - `operator` string, required — Specifies the operation to be performed by the filter (IN_LIST, NOT_IN_LIST). - PublicNumAssociationsFilter - `associationCategory` string, required — Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'NUM_ASSOCIATIONS', required — Indicates the type of filter being applied (NUM_ASSOCIATIONS). - PublicUnifiedEventsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string — The identifier for the type of event in the unified events filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'UNIFIED_EVENTS', required — Indicates the type of filter being applied (UNIFIED_EVENTS). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPropertyAssociationInListFilter - `coalescingRefineBy` union, required — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'PROPERTY_ASSOCIATION', required — Indicates the type of filter being applied (PROPERTY_ASSOCIATION). - `listId` string, required — The ID of the list used in the property association filter. - `operator` string, required — Defines the operation to be applied by the filter (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property associated with the object ID in the filter. - `toObjectTypeId` string — The ID representing the type of object that the property association filter is targeting. - PublicConstantFilter - `filterType` 'CONSTANT', required — Specifies the type of filter, which is (CONSTANT). - `shouldAccept` boolean, required — Indicates whether the filter should accept the condition. - `source` string — Defines the source of the constant filter. - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Specifies the logical operator used to combine filters within the branch (NOT_ANY). - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch (NOT_ANY). - `filterBranches` union[], required - union - PublicOrFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine the filters within the branch (OR). - `filterBranchType` 'OR', required — The type of the filter branch (OR). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'AND', required — Type of filter branch (AND) - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — The operator used to combine filters within the branch (NOT_ALL). - `filterBranchType` 'NOT_ALL', required — The type of the filter branch (NOT_ALL). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch — recursive - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the restricted filter branch. - `filterBranchType` 'RESTRICTED', required — Specifies the type of the filter branch (RESTRICTED). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string, required — The identifier for the type of event associated with the filter branch. - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch (AND). - `filterBranchType` 'UNIFIED_EVENTS', required — The type of the filter branch (UNIFIED_EVENTS). - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Defines the operation to be applied within the filter branch (HAS_COMPLETED, HAS_NOT_COMPLETED). - `pruningRefineBy` union - … - PublicPropertyAssociationFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch. - `filterBranchType` 'PROPERTY_ASSOCIATION', required — The type of the filter branch (PROPERTY_ASSOCIATION). - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property that is associated with the object ID in the filter branch. - PublicAssociationFilterBranch - `associationCategory` string, required — Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — Type id of the association - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'ASSOCIATION', required — Type of the filter branch (ASSOCIATION) - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `filters` union[], required - union - PublicPropertyFilter - `filterType` 'PROPERTY', required — Indicates that the filter (PROPERTY). - `operation` union, required — Defines the operation to be performed on the property, such as comparison or value matching. - … - `property` string, required — Specifies the name of the property that the filter is applied to. - PublicAssociationInListFilter - `associationCategory` string, required — Defines the category of the association, such as (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'ASSOCIATION', required — Indicates the type of filter being applied, which is 'ASSOCIATION' by default. - `listId` string, required — The ID of the list used in the association filter. - `operator` string, required — Specifies the operation to be performed by the filter, such as 'IN_LIST' or 'NOT_IN_LIST'. - `toObjectType` string — The type of object that the association filter is targeting. - `toObjectTypeId` string — The ID representing the type of object that the association filter is targeting. - PublicPageViewAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `enableTracking` boolean — Indicates whether tracking is enabled for the page view. - `filterType` 'PAGE_VIEW', required — Indicates the type of filter being applied (PAGE_VIEW). - `operator` string, required — Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS). - `pageUrl` string, required — The URL of the page to be used in the filter. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicCtaAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `ctaName` string, required — The name of the Call-to-Action (CTA) to be used in the filter. - `filterType` 'CTA', required — Indicates the type of filter being applied, which is (CTA). - `operator` string, required — Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicEventAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the event filter by coalescing. - … - `eventId` string, required — The ID of the event to be used in the filter. - `filterType` 'EVENT', required — Indicates the type of filter being applied (EVENT). - `operator` string, required — Defines the operation to be applied within the event filter (HAS_EVENT, NOT_HAS_EVENT). - `pruningRefineBy` union — Specifies the criteria for refining the event filter by pruning. - … - PublicFormSubmissionFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION', required — Indicates the type of filter (FORM_SUBMISSION). - `formId` string — The ID of the form used in the filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be performed (FILLED_OUT, NOT_FILLED_OUT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicFormSubmissionOnPageFilter - `coalescingRefineBy` union — Defines the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION_ON_PAGE', required — Indicates the type of filter (FORM_SUBMISSION_ON_PAGE). - `formId` string — The ID of the form associated with the submission filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT). - `pageId` string, required — The ID of the page where the form submission occurred. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicIntegrationEventFilter - `eventTypeId` integer, required — The ID representing the type of event for the integration event filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'INTEGRATION_EVENT', required — Indicates the type of filter (INTEGRATION_EVENT). - PublicEmailSubscriptionFilter - `acceptedStatuses` string[], required - `filterType` 'EMAIL_SUBSCRIPTION', required — Indicates the type of filter (EMAIL_SUBSCRIPTION). - `subscriptionIds` string[], required - `subscriptionType` string — The type of subscription related to the filter (PORTAL, BRAND, SUBSCRIPTION, HARDBOUNCE, SPAMREPORT). - PublicCommunicationSubscriptionFilter - `acceptedOptStates` string[], required - `businessUnitId` string — The ID of the business unit associated with the subscription filter. - `channel` string, required — Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS). - `filterType` 'COMMUNICATION_SUBSCRIPTION', required — Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION) - `subscriptionIds` string[], required - `subscriptionType` string, required — Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION) - PublicCampaignInfluencedFilter - `campaignId` string, required — The ID of the campaign that influences the filter. - `filterType` 'CAMPAIGN_INFLUENCED', required — Indicates the type of filter (CAMPAIGN_INFLUENCED). - PublicSurveyMonkeyFilter - `filterType` 'SURVEY_MONKEY', required — Indicates the type of filter being applied (SURVEY_MONKEY). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_RESPONDED_TO_SURVEY, HAS_NOT_RESPONDED_TO_SURVEY). - `surveyId` string, required — The ID of the survey associated with the filter. - PublicSurveyMonkeyValueFilter - `filterType` 'SURVEY_MONKEY_VALUE', required — Defines the type of filter (SURVEY_MONKEY_VALUE). - `operator` string, required — Defines the operation to be applied within the filter (HAS_ANSWERED_SURVEY_QUESTION_WITH_VALUE). - `surveyAnswerColId` string — The column ID of the survey answer used in the filter. - `surveyAnswerRowId` string — The row ID of the survey answer used in the filter. - `surveyId` string, required — The ID of the survey used in the filter. - `surveyQuestion` string, required — The question from the survey used in the filter. - `valueComparison` union, required — Specifies the operation used to compare the survey answer value. - … - PublicWebinarFilter - `filterType` 'WEBINAR', required — Indicates the type of filter, (WEBINAR). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_WEBINAR_REGISTRATION, NOT_HAS_WEBINAR_REGISTRATION, HAS_WEBINAR_ATTENDANCE, NOT_HAS_WEBINAR_ATTENDANCE). - `webinarId` string — The ID of the webinar associated with the filter. - PublicEmailEventFilter - `appId` string, required — The ID of the application associated with the email event filter. - `clickUrl` string — The URL that was clicked in the email event. - `emailId` string, required — The ID of the email associated with the event filter. - `filterType` 'EMAIL_EVENT', required — Indicates the type of filter (EMAIL_EVENT). - `level` string, required — Specifies the level of the email event, such as EMAIL_API_CAMPAIGN_GROUP. - `operator` 'BOUNCED' | 'LINK_CLICKED' | 'MARKED_SPAM' | 'OPENED' | 'OPENED_BUT_LINK_NOT_CLICKED' | 'OPENED_BUT_NOT_REPLIED' | 'RECEIVED' | 'RECEIVED_BUT_NOT_OPENED' | 'REPLIED' | 'SENT' | 'SENT_BUT_LINK_NOT_CLICKED' | 'SENT_BUT_NOT_RECEIVED' | 'UNSUBSCRIBED', required — Defines the operation to be applied within the filter (BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPrivacyAnalyticsFilter - `filterType` 'PRIVACY', required — Specifies the type of filter (PRIVACY). - `operator` string, required — Defines the operation to be applied within the filter (PRIVACY_CONSENT_GRANTED, PRIVACY_CONSENT_NOT_GRANTED). - `privacyName` string, required — The name of the privacy setting used in the filter. - PublicAdsSearchFilter - `adNetwork` string, required — Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL) - `entityType` string, required — Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN) - `filterType` 'ADS_SEARCH', required — Type of the filter (ADS_SEARCH) - `operator` string, required — Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN) - `searchTermType` string, required — Search term to match an ad - `searchTerms` string[], required - PublicAdsTimeFilter - `filterType` 'ADS_TIME', required — Filter type (ADS_TIME) - `pruningRefineBy` union, required — Refinement criteria - … - PublicInListFilter - `filterType` 'IN_LIST', required — Indicates the type of filter being applied (IN_LIST). - `listId` string, required — The ID of the list used in the association filter. - `metadata` PublicInListFilterMetadata - … - `operator` string, required — Specifies the operation to be performed by the filter (IN_LIST, NOT_IN_LIST). - PublicNumAssociationsFilter - `associationCategory` string, required — Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'NUM_ASSOCIATIONS', required — Indicates the type of filter being applied (NUM_ASSOCIATIONS). - PublicUnifiedEventsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string — The identifier for the type of event in the unified events filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'UNIFIED_EVENTS', required — Indicates the type of filter being applied (UNIFIED_EVENTS). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPropertyAssociationInListFilter - `coalescingRefineBy` union, required — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'PROPERTY_ASSOCIATION', required — Indicates the type of filter being applied (PROPERTY_ASSOCIATION). - `listId` string, required — The ID of the list used in the property association filter. - `operator` string, required — Defines the operation to be applied by the filter (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property associated with the object ID in the filter. - `toObjectTypeId` string — The ID representing the type of object that the property association filter is targeting. - PublicConstantFilter - `filterType` 'CONSTANT', required — Specifies the type of filter, which is (CONSTANT). - `shouldAccept` boolean, required — Indicates whether the filter should accept the condition. - `source` string — Defines the source of the constant filter. - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the restricted filter branch. - `filterBranchType` 'RESTRICTED', required — Specifies the type of the filter branch (RESTRICTED). - `filterBranches` union[], required - union - PublicOrFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine the filters within the branch (OR). - `filterBranchType` 'OR', required — The type of the filter branch (OR). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'AND', required — Type of filter branch (AND) - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — The operator used to combine filters within the branch (NOT_ALL). - `filterBranchType` 'NOT_ALL', required — The type of the filter branch (NOT_ALL). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Specifies the logical operator used to combine filters within the branch (NOT_ANY). - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch (NOT_ANY). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch — recursive - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string, required — The identifier for the type of event associated with the filter branch. - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch (AND). - `filterBranchType` 'UNIFIED_EVENTS', required — The type of the filter branch (UNIFIED_EVENTS). - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Defines the operation to be applied within the filter branch (HAS_COMPLETED, HAS_NOT_COMPLETED). - `pruningRefineBy` union - … - PublicPropertyAssociationFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch. - `filterBranchType` 'PROPERTY_ASSOCIATION', required — The type of the filter branch (PROPERTY_ASSOCIATION). - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property that is associated with the object ID in the filter branch. - PublicAssociationFilterBranch - `associationCategory` string, required — Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — Type id of the association - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'ASSOCIATION', required — Type of the filter branch (ASSOCIATION) - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `filters` union[], required - union - PublicPropertyFilter - `filterType` 'PROPERTY', required — Indicates that the filter (PROPERTY). - `operation` union, required — Defines the operation to be performed on the property, such as comparison or value matching. - … - `property` string, required — Specifies the name of the property that the filter is applied to. - PublicAssociationInListFilter - `associationCategory` string, required — Defines the category of the association, such as (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'ASSOCIATION', required — Indicates the type of filter being applied, which is 'ASSOCIATION' by default. - `listId` string, required — The ID of the list used in the association filter. - `operator` string, required — Specifies the operation to be performed by the filter, such as 'IN_LIST' or 'NOT_IN_LIST'. - `toObjectType` string — The type of object that the association filter is targeting. - `toObjectTypeId` string — The ID representing the type of object that the association filter is targeting. - PublicPageViewAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `enableTracking` boolean — Indicates whether tracking is enabled for the page view. - `filterType` 'PAGE_VIEW', required — Indicates the type of filter being applied (PAGE_VIEW). - `operator` string, required — Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS). - `pageUrl` string, required — The URL of the page to be used in the filter. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicCtaAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `ctaName` string, required — The name of the Call-to-Action (CTA) to be used in the filter. - `filterType` 'CTA', required — Indicates the type of filter being applied, which is (CTA). - `operator` string, required — Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicEventAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the event filter by coalescing. - … - `eventId` string, required — The ID of the event to be used in the filter. - `filterType` 'EVENT', required — Indicates the type of filter being applied (EVENT). - `operator` string, required — Defines the operation to be applied within the event filter (HAS_EVENT, NOT_HAS_EVENT). - `pruningRefineBy` union — Specifies the criteria for refining the event filter by pruning. - … - PublicFormSubmissionFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION', required — Indicates the type of filter (FORM_SUBMISSION). - `formId` string — The ID of the form used in the filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be performed (FILLED_OUT, NOT_FILLED_OUT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicFormSubmissionOnPageFilter - `coalescingRefineBy` union — Defines the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION_ON_PAGE', required — Indicates the type of filter (FORM_SUBMISSION_ON_PAGE). - `formId` string — The ID of the form associated with the submission filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT). - `pageId` string, required — The ID of the page where the form submission occurred. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicIntegrationEventFilter - `eventTypeId` integer, required — The ID representing the type of event for the integration event filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'INTEGRATION_EVENT', required — Indicates the type of filter (INTEGRATION_EVENT). - PublicEmailSubscriptionFilter - `acceptedStatuses` string[], required - `filterType` 'EMAIL_SUBSCRIPTION', required — Indicates the type of filter (EMAIL_SUBSCRIPTION). - `subscriptionIds` string[], required - `subscriptionType` string — The type of subscription related to the filter (PORTAL, BRAND, SUBSCRIPTION, HARDBOUNCE, SPAMREPORT). - PublicCommunicationSubscriptionFilter - `acceptedOptStates` string[], required - `businessUnitId` string — The ID of the business unit associated with the subscription filter. - `channel` string, required — Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS). - `filterType` 'COMMUNICATION_SUBSCRIPTION', required — Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION) - `subscriptionIds` string[], required - `subscriptionType` string, required — Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION) - PublicCampaignInfluencedFilter - `campaignId` string, required — The ID of the campaign that influences the filter. - `filterType` 'CAMPAIGN_INFLUENCED', required — Indicates the type of filter (CAMPAIGN_INFLUENCED). - PublicSurveyMonkeyFilter - `filterType` 'SURVEY_MONKEY', required — Indicates the type of filter being applied (SURVEY_MONKEY). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_RESPONDED_TO_SURVEY, HAS_NOT_RESPONDED_TO_SURVEY). - `surveyId` string, required — The ID of the survey associated with the filter. - PublicSurveyMonkeyValueFilter - `filterType` 'SURVEY_MONKEY_VALUE', required — Defines the type of filter (SURVEY_MONKEY_VALUE). - `operator` string, required — Defines the operation to be applied within the filter (HAS_ANSWERED_SURVEY_QUESTION_WITH_VALUE). - `surveyAnswerColId` string — The column ID of the survey answer used in the filter. - `surveyAnswerRowId` string — The row ID of the survey answer used in the filter. - `surveyId` string, required — The ID of the survey used in the filter. - `surveyQuestion` string, required — The question from the survey used in the filter. - `valueComparison` union, required — Specifies the operation used to compare the survey answer value. - … - PublicWebinarFilter - `filterType` 'WEBINAR', required — Indicates the type of filter, (WEBINAR). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_WEBINAR_REGISTRATION, NOT_HAS_WEBINAR_REGISTRATION, HAS_WEBINAR_ATTENDANCE, NOT_HAS_WEBINAR_ATTENDANCE). - `webinarId` string — The ID of the webinar associated with the filter. - PublicEmailEventFilter - `appId` string, required — The ID of the application associated with the email event filter. - `clickUrl` string — The URL that was clicked in the email event. - `emailId` string, required — The ID of the email associated with the event filter. - `filterType` 'EMAIL_EVENT', required — Indicates the type of filter (EMAIL_EVENT). - `level` string, required — Specifies the level of the email event, such as EMAIL_API_CAMPAIGN_GROUP. - `operator` 'BOUNCED' | 'LINK_CLICKED' | 'MARKED_SPAM' | 'OPENED' | 'OPENED_BUT_LINK_NOT_CLICKED' | 'OPENED_BUT_NOT_REPLIED' | 'RECEIVED' | 'RECEIVED_BUT_NOT_OPENED' | 'REPLIED' | 'SENT' | 'SENT_BUT_LINK_NOT_CLICKED' | 'SENT_BUT_NOT_RECEIVED' | 'UNSUBSCRIBED', required — Defines the operation to be applied within the filter (BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPrivacyAnalyticsFilter - `filterType` 'PRIVACY', required — Specifies the type of filter (PRIVACY). - `operator` string, required — Defines the operation to be applied within the filter (PRIVACY_CONSENT_GRANTED, PRIVACY_CONSENT_NOT_GRANTED). - `privacyName` string, required — The name of the privacy setting used in the filter. - PublicAdsSearchFilter - `adNetwork` string, required — Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL) - `entityType` string, required — Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN) - `filterType` 'ADS_SEARCH', required — Type of the filter (ADS_SEARCH) - `operator` string, required — Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN) - `searchTermType` string, required — Search term to match an ad - `searchTerms` string[], required - PublicAdsTimeFilter - `filterType` 'ADS_TIME', required — Filter type (ADS_TIME) - `pruningRefineBy` union, required — Refinement criteria - … - PublicInListFilter - `filterType` 'IN_LIST', required — Indicates the type of filter being applied (IN_LIST). - `listId` string, required — The ID of the list used in the association filter. - `metadata` PublicInListFilterMetadata - … - `operator` string, required — Specifies the operation to be performed by the filter (IN_LIST, NOT_IN_LIST). - PublicNumAssociationsFilter - `associationCategory` string, required — Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'NUM_ASSOCIATIONS', required — Indicates the type of filter being applied (NUM_ASSOCIATIONS). - PublicUnifiedEventsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string — The identifier for the type of event in the unified events filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'UNIFIED_EVENTS', required — Indicates the type of filter being applied (UNIFIED_EVENTS). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPropertyAssociationInListFilter - `coalescingRefineBy` union, required — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'PROPERTY_ASSOCIATION', required — Indicates the type of filter being applied (PROPERTY_ASSOCIATION). - `listId` string, required — The ID of the list used in the property association filter. - `operator` string, required — Defines the operation to be applied by the filter (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property associated with the object ID in the filter. - `toObjectTypeId` string — The ID representing the type of object that the property association filter is targeting. - PublicConstantFilter - `filterType` 'CONSTANT', required — Specifies the type of filter, which is (CONSTANT). - `shouldAccept` boolean, required — Indicates whether the filter should accept the condition. - `source` string — Defines the source of the constant filter. - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - PublicNumOccurrencesRefineBy - `maxOccurrences` integer — The maximum number of occurrences allowed. - `minOccurrences` integer — The minimum number of occurrences required. - `type` 'NUM_OCCURRENCES', required — The type of refinement (NUM_OCCURRENCES). - PublicSetOccurrencesRefineBy - `setType` string, required — Indicates the specific set type used in the refinement (ALL, ALL_INCLUDE_EMPTY, ANY, NONE, NONE_EXCLUDE_EMPTY, ANY_INCLUDE_EMPTY). - `type` 'SET_OCCURRENCES', required — Specifies the type of refinement (SET_OCCURRENCES). - PublicRelativeComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation to be used in the refinement (BEFORE, AFTER). - `timeOffset` PublicTimeOffset, required - `amount` integer, required — The numerical value representing the quantity of the time offset. - `offsetDirection` string, required — Indicates the direction of the time offset, such as forward or backward. - `timeUnit` string, required — Specifies the unit of time for the offset, such as days, hours, or minutes. - `type` 'RELATIVE_COMPARATIVE', required — Specifies the type of refinement, (RELATIVE_COMPARATIVE). - PublicRelativeRangedTimestampRefineBy - `lowerBoundOffset` PublicTimeOffset, required - `amount` integer, required — The numerical value representing the quantity of the time offset. - `offsetDirection` string, required — Indicates the direction of the time offset, such as forward or backward. - `timeUnit` string, required — Specifies the unit of time for the offset, such as days, hours, or minutes. - `rangeType` string, required — Specifies the type of range for the refinement criteria (BETWEEN, NOT_BETWEEN). - `type` 'RELATIVE_RANGED', required — Indicates the type of refinement (RELATIVE_RANGED). - `upperBoundOffset` PublicTimeOffset, required - `amount` integer, required — The numerical value representing the quantity of the time offset. - `offsetDirection` string, required — Indicates the direction of the time offset, such as forward or backward. - `timeUnit` string, required — Specifies the unit of time for the offset, such as days, hours, or minutes. - PublicAbsoluteComparativeTimestampRefineBy - `comparison` string, required — Timestamp comparison options (BEFORE, AFTER) - `timestamp` integer, required — Timestamp to be used in refine by criteria - `type` 'ABSOLUTE_COMPARATIVE', required — type of refine by criteria (ABSOLUTE_COMPARATIVE) - PublicAbsoluteRangedTimestampRefineBy - `lowerTimestamp` integer, required — Lower range timestamp of refinement criteria - `rangeType` string, required — Type of range of refinement critaria (BETWEEN, NOT_BETWEEN) - `type` 'ABSOLUTE_RANGED', required — type of refine by criteria (ABSOLUTE_RANGED) - `upperTimestamp` integer, required — Upper range timestamp of refinement criteria - PublicAllHistoryRefineBy - `type` 'ALL_HISTORY', required — Type of refine by (ALL_HISTORY) - PublicTimePointOperation - `endpointBehavior` string — Describes the behavior at the endpoint of the time point operation. - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects with no value set for the property should be included in the operation. - `operationType` 'TIME_POINT', required — Specifies the type of operation (TIME_POINT). - `operator` string, required — Specifies the operation to be applied within the time point operation (IS_BEFORE, IS_AFTER). - `propertyParser` string — Specifies the parser used for interpreting the property in the operation. - `timePoint` union, required — Defines the specific point in time for the operation, which can be a date, indexed time, or property-referenced time. - PublicDatePoint - … - PublicIndexedTimePoint - … - PublicPropertyReferencedTime - … - `type` string, required — Defines the type of operation being performed. - PublicRangedTimeOperation - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects with no value set for the property should be included in the operation. - `lowerBoundEndpointBehavior` string — Describes the behavior at the lower bound endpoint of the time range. - `lowerBoundTimePoint` union, required — Defines the lower bound time point for the operation. - PublicDatePoint - … - PublicIndexedTimePoint - … - PublicPropertyReferencedTime - … - `operationType` string, required — Specifies the type of operation (TIME_RANGED). - `operator` string, required — Defines the operation to be applied within the time range (IS_BETWEEN, IS_NOT_BETWEEN). - `propertyParser` string — Specifies the parser used for the property in the operation. - `type` 'TIME_RANGED', required — Specifies the type of operation (TIME_RANGED). - `upperBoundEndpointBehavior` string — Describes the behavior at the upper bound endpoint of the time range. - `upperBoundTimePoint` union, required — Defines the upper bound time point for the operation. - PublicDatePoint - … - PublicIndexedTimePoint - … - PublicPropertyReferencedTime - … - `eventTypeId` string, required — The identifier for the type of event associated with the filter branch. - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch (AND). - `filterBranchType` 'UNIFIED_EVENTS', required — The type of the filter branch (UNIFIED_EVENTS). - `filterBranches` union[], required - union - PublicOrFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine the filters within the branch (OR). - `filterBranchType` 'OR', required — The type of the filter branch (OR). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'AND', required — Type of filter branch (AND) - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — The operator used to combine filters within the branch (NOT_ALL). - `filterBranchType` 'NOT_ALL', required — The type of the filter branch (NOT_ALL). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Specifies the logical operator used to combine filters within the branch (NOT_ANY). - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch (NOT_ANY). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the restricted filter branch. - `filterBranchType` 'RESTRICTED', required — Specifies the type of the filter branch (RESTRICTED). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch — recursive - PublicPropertyAssociationFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch. - `filterBranchType` 'PROPERTY_ASSOCIATION', required — The type of the filter branch (PROPERTY_ASSOCIATION). - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property that is associated with the object ID in the filter branch. - PublicAssociationFilterBranch - `associationCategory` string, required — Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — Type id of the association - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'ASSOCIATION', required — Type of the filter branch (ASSOCIATION) - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `filters` union[], required - union - PublicPropertyFilter - `filterType` 'PROPERTY', required — Indicates that the filter (PROPERTY). - `operation` union, required — Defines the operation to be performed on the property, such as comparison or value matching. - … - `property` string, required — Specifies the name of the property that the filter is applied to. - PublicAssociationInListFilter - `associationCategory` string, required — Defines the category of the association, such as (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'ASSOCIATION', required — Indicates the type of filter being applied, which is 'ASSOCIATION' by default. - `listId` string, required — The ID of the list used in the association filter. - `operator` string, required — Specifies the operation to be performed by the filter, such as 'IN_LIST' or 'NOT_IN_LIST'. - `toObjectType` string — The type of object that the association filter is targeting. - `toObjectTypeId` string — The ID representing the type of object that the association filter is targeting. - PublicPageViewAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `enableTracking` boolean — Indicates whether tracking is enabled for the page view. - `filterType` 'PAGE_VIEW', required — Indicates the type of filter being applied (PAGE_VIEW). - `operator` string, required — Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS). - `pageUrl` string, required — The URL of the page to be used in the filter. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicCtaAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `ctaName` string, required — The name of the Call-to-Action (CTA) to be used in the filter. - `filterType` 'CTA', required — Indicates the type of filter being applied, which is (CTA). - `operator` string, required — Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicEventAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the event filter by coalescing. - … - `eventId` string, required — The ID of the event to be used in the filter. - `filterType` 'EVENT', required — Indicates the type of filter being applied (EVENT). - `operator` string, required — Defines the operation to be applied within the event filter (HAS_EVENT, NOT_HAS_EVENT). - `pruningRefineBy` union — Specifies the criteria for refining the event filter by pruning. - … - PublicFormSubmissionFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION', required — Indicates the type of filter (FORM_SUBMISSION). - `formId` string — The ID of the form used in the filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be performed (FILLED_OUT, NOT_FILLED_OUT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicFormSubmissionOnPageFilter - `coalescingRefineBy` union — Defines the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION_ON_PAGE', required — Indicates the type of filter (FORM_SUBMISSION_ON_PAGE). - `formId` string — The ID of the form associated with the submission filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT). - `pageId` string, required — The ID of the page where the form submission occurred. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicIntegrationEventFilter - `eventTypeId` integer, required — The ID representing the type of event for the integration event filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'INTEGRATION_EVENT', required — Indicates the type of filter (INTEGRATION_EVENT). - PublicEmailSubscriptionFilter - `acceptedStatuses` string[], required - `filterType` 'EMAIL_SUBSCRIPTION', required — Indicates the type of filter (EMAIL_SUBSCRIPTION). - `subscriptionIds` string[], required - `subscriptionType` string — The type of subscription related to the filter (PORTAL, BRAND, SUBSCRIPTION, HARDBOUNCE, SPAMREPORT). - PublicCommunicationSubscriptionFilter - `acceptedOptStates` string[], required - `businessUnitId` string — The ID of the business unit associated with the subscription filter. - `channel` string, required — Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS). - `filterType` 'COMMUNICATION_SUBSCRIPTION', required — Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION) - `subscriptionIds` string[], required - `subscriptionType` string, required — Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION) - PublicCampaignInfluencedFilter - `campaignId` string, required — The ID of the campaign that influences the filter. - `filterType` 'CAMPAIGN_INFLUENCED', required — Indicates the type of filter (CAMPAIGN_INFLUENCED). - PublicSurveyMonkeyFilter - `filterType` 'SURVEY_MONKEY', required — Indicates the type of filter being applied (SURVEY_MONKEY). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_RESPONDED_TO_SURVEY, HAS_NOT_RESPONDED_TO_SURVEY). - `surveyId` string, required — The ID of the survey associated with the filter. - PublicSurveyMonkeyValueFilter - `filterType` 'SURVEY_MONKEY_VALUE', required — Defines the type of filter (SURVEY_MONKEY_VALUE). - `operator` string, required — Defines the operation to be applied within the filter (HAS_ANSWERED_SURVEY_QUESTION_WITH_VALUE). - `surveyAnswerColId` string — The column ID of the survey answer used in the filter. - `surveyAnswerRowId` string — The row ID of the survey answer used in the filter. - `surveyId` string, required — The ID of the survey used in the filter. - `surveyQuestion` string, required — The question from the survey used in the filter. - `valueComparison` union, required — Specifies the operation used to compare the survey answer value. - … - PublicWebinarFilter - `filterType` 'WEBINAR', required — Indicates the type of filter, (WEBINAR). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_WEBINAR_REGISTRATION, NOT_HAS_WEBINAR_REGISTRATION, HAS_WEBINAR_ATTENDANCE, NOT_HAS_WEBINAR_ATTENDANCE). - `webinarId` string — The ID of the webinar associated with the filter. - PublicEmailEventFilter - `appId` string, required — The ID of the application associated with the email event filter. - `clickUrl` string — The URL that was clicked in the email event. - `emailId` string, required — The ID of the email associated with the event filter. - `filterType` 'EMAIL_EVENT', required — Indicates the type of filter (EMAIL_EVENT). - `level` string, required — Specifies the level of the email event, such as EMAIL_API_CAMPAIGN_GROUP. - `operator` 'BOUNCED' | 'LINK_CLICKED' | 'MARKED_SPAM' | 'OPENED' | 'OPENED_BUT_LINK_NOT_CLICKED' | 'OPENED_BUT_NOT_REPLIED' | 'RECEIVED' | 'RECEIVED_BUT_NOT_OPENED' | 'REPLIED' | 'SENT' | 'SENT_BUT_LINK_NOT_CLICKED' | 'SENT_BUT_NOT_RECEIVED' | 'UNSUBSCRIBED', required — Defines the operation to be applied within the filter (BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPrivacyAnalyticsFilter - `filterType` 'PRIVACY', required — Specifies the type of filter (PRIVACY). - `operator` string, required — Defines the operation to be applied within the filter (PRIVACY_CONSENT_GRANTED, PRIVACY_CONSENT_NOT_GRANTED). - `privacyName` string, required — The name of the privacy setting used in the filter. - PublicAdsSearchFilter - `adNetwork` string, required — Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL) - `entityType` string, required — Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN) - `filterType` 'ADS_SEARCH', required — Type of the filter (ADS_SEARCH) - `operator` string, required — Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN) - `searchTermType` string, required — Search term to match an ad - `searchTerms` string[], required - PublicAdsTimeFilter - `filterType` 'ADS_TIME', required — Filter type (ADS_TIME) - `pruningRefineBy` union, required — Refinement criteria - … - PublicInListFilter - `filterType` 'IN_LIST', required — Indicates the type of filter being applied (IN_LIST). - `listId` string, required — The ID of the list used in the association filter. - `metadata` PublicInListFilterMetadata - … - `operator` string, required — Specifies the operation to be performed by the filter (IN_LIST, NOT_IN_LIST). - PublicNumAssociationsFilter - `associationCategory` string, required — Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'NUM_ASSOCIATIONS', required — Indicates the type of filter being applied (NUM_ASSOCIATIONS). - PublicUnifiedEventsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string — The identifier for the type of event in the unified events filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'UNIFIED_EVENTS', required — Indicates the type of filter being applied (UNIFIED_EVENTS). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPropertyAssociationInListFilter - `coalescingRefineBy` union, required — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'PROPERTY_ASSOCIATION', required — Indicates the type of filter being applied (PROPERTY_ASSOCIATION). - `listId` string, required — The ID of the list used in the property association filter. - `operator` string, required — Defines the operation to be applied by the filter (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property associated with the object ID in the filter. - `toObjectTypeId` string — The ID representing the type of object that the property association filter is targeting. - PublicConstantFilter - `filterType` 'CONSTANT', required — Specifies the type of filter, which is (CONSTANT). - `shouldAccept` boolean, required — Indicates whether the filter should accept the condition. - `source` string — Defines the source of the constant filter. - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Defines the operation to be applied within the filter branch (HAS_COMPLETED, HAS_NOT_COMPLETED). - `pruningRefineBy` union - PublicNumOccurrencesRefineBy - `maxOccurrences` integer — The maximum number of occurrences allowed. - `minOccurrences` integer — The minimum number of occurrences required. - `type` 'NUM_OCCURRENCES', required — The type of refinement (NUM_OCCURRENCES). - PublicSetOccurrencesRefineBy - `setType` string, required — Indicates the specific set type used in the refinement (ALL, ALL_INCLUDE_EMPTY, ANY, NONE, NONE_EXCLUDE_EMPTY, ANY_INCLUDE_EMPTY). - `type` 'SET_OCCURRENCES', required — Specifies the type of refinement (SET_OCCURRENCES). - PublicRelativeComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation to be used in the refinement (BEFORE, AFTER). - `timeOffset` PublicTimeOffset, required - `amount` integer, required — The numerical value representing the quantity of the time offset. - `offsetDirection` string, required — Indicates the direction of the time offset, such as forward or backward. - `timeUnit` string, required — Specifies the unit of time for the offset, such as days, hours, or minutes. - `type` 'RELATIVE_COMPARATIVE', required — Specifies the type of refinement, (RELATIVE_COMPARATIVE). - PublicRelativeRangedTimestampRefineBy - `lowerBoundOffset` PublicTimeOffset, required - `amount` integer, required — The numerical value representing the quantity of the time offset. - `offsetDirection` string, required — Indicates the direction of the time offset, such as forward or backward. - `timeUnit` string, required — Specifies the unit of time for the offset, such as days, hours, or minutes. - `rangeType` string, required — Specifies the type of range for the refinement criteria (BETWEEN, NOT_BETWEEN). - `type` 'RELATIVE_RANGED', required — Indicates the type of refinement (RELATIVE_RANGED). - `upperBoundOffset` PublicTimeOffset, required - `amount` integer, required — The numerical value representing the quantity of the time offset. - `offsetDirection` string, required — Indicates the direction of the time offset, such as forward or backward. - `timeUnit` string, required — Specifies the unit of time for the offset, such as days, hours, or minutes. - PublicAbsoluteComparativeTimestampRefineBy - `comparison` string, required — Timestamp comparison options (BEFORE, AFTER) - `timestamp` integer, required — Timestamp to be used in refine by criteria - `type` 'ABSOLUTE_COMPARATIVE', required — type of refine by criteria (ABSOLUTE_COMPARATIVE) - PublicAbsoluteRangedTimestampRefineBy - `lowerTimestamp` integer, required — Lower range timestamp of refinement criteria - `rangeType` string, required — Type of range of refinement critaria (BETWEEN, NOT_BETWEEN) - `type` 'ABSOLUTE_RANGED', required — type of refine by criteria (ABSOLUTE_RANGED) - `upperTimestamp` integer, required — Upper range timestamp of refinement criteria - PublicAllHistoryRefineBy - `type` 'ALL_HISTORY', required — Type of refine by (ALL_HISTORY) - PublicTimePointOperation - `endpointBehavior` string — Describes the behavior at the endpoint of the time point operation. - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects with no value set for the property should be included in the operation. - `operationType` 'TIME_POINT', required — Specifies the type of operation (TIME_POINT). - `operator` string, required — Specifies the operation to be applied within the time point operation (IS_BEFORE, IS_AFTER). - `propertyParser` string — Specifies the parser used for interpreting the property in the operation. - `timePoint` union, required — Defines the specific point in time for the operation, which can be a date, indexed time, or property-referenced time. - PublicDatePoint - … - PublicIndexedTimePoint - … - PublicPropertyReferencedTime - … - `type` string, required — Defines the type of operation being performed. - PublicRangedTimeOperation - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects with no value set for the property should be included in the operation. - `lowerBoundEndpointBehavior` string — Describes the behavior at the lower bound endpoint of the time range. - `lowerBoundTimePoint` union, required — Defines the lower bound time point for the operation. - PublicDatePoint - … - PublicIndexedTimePoint - … - PublicPropertyReferencedTime - … - `operationType` string, required — Specifies the type of operation (TIME_RANGED). - `operator` string, required — Defines the operation to be applied within the time range (IS_BETWEEN, IS_NOT_BETWEEN). - `propertyParser` string — Specifies the parser used for the property in the operation. - `type` 'TIME_RANGED', required — Specifies the type of operation (TIME_RANGED). - `upperBoundEndpointBehavior` string — Describes the behavior at the upper bound endpoint of the time range. - `upperBoundTimePoint` union, required — Defines the upper bound time point for the operation. - PublicDatePoint - … - PublicIndexedTimePoint - … - PublicPropertyReferencedTime - … - PublicPropertyAssociationFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch. - `filterBranchType` 'PROPERTY_ASSOCIATION', required — The type of the filter branch (PROPERTY_ASSOCIATION). - `filterBranches` union[], required - union - PublicOrFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine the filters within the branch (OR). - `filterBranchType` 'OR', required — The type of the filter branch (OR). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'AND', required — Type of filter branch (AND) - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — The operator used to combine filters within the branch (NOT_ALL). - `filterBranchType` 'NOT_ALL', required — The type of the filter branch (NOT_ALL). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Specifies the logical operator used to combine filters within the branch (NOT_ANY). - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch (NOT_ANY). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the restricted filter branch. - `filterBranchType` 'RESTRICTED', required — Specifies the type of the filter branch (RESTRICTED). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string, required — The identifier for the type of event associated with the filter branch. - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch (AND). - `filterBranchType` 'UNIFIED_EVENTS', required — The type of the filter branch (UNIFIED_EVENTS). - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Defines the operation to be applied within the filter branch (HAS_COMPLETED, HAS_NOT_COMPLETED). - `pruningRefineBy` union - … - PublicPropertyAssociationFilterBranch — recursive - PublicAssociationFilterBranch - `associationCategory` string, required — Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — Type id of the association - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'ASSOCIATION', required — Type of the filter branch (ASSOCIATION) - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `filters` union[], required - union - PublicPropertyFilter - `filterType` 'PROPERTY', required — Indicates that the filter (PROPERTY). - `operation` union, required — Defines the operation to be performed on the property, such as comparison or value matching. - … - `property` string, required — Specifies the name of the property that the filter is applied to. - PublicAssociationInListFilter - `associationCategory` string, required — Defines the category of the association, such as (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'ASSOCIATION', required — Indicates the type of filter being applied, which is 'ASSOCIATION' by default. - `listId` string, required — The ID of the list used in the association filter. - `operator` string, required — Specifies the operation to be performed by the filter, such as 'IN_LIST' or 'NOT_IN_LIST'. - `toObjectType` string — The type of object that the association filter is targeting. - `toObjectTypeId` string — The ID representing the type of object that the association filter is targeting. - PublicPageViewAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `enableTracking` boolean — Indicates whether tracking is enabled for the page view. - `filterType` 'PAGE_VIEW', required — Indicates the type of filter being applied (PAGE_VIEW). - `operator` string, required — Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS). - `pageUrl` string, required — The URL of the page to be used in the filter. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicCtaAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `ctaName` string, required — The name of the Call-to-Action (CTA) to be used in the filter. - `filterType` 'CTA', required — Indicates the type of filter being applied, which is (CTA). - `operator` string, required — Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicEventAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the event filter by coalescing. - … - `eventId` string, required — The ID of the event to be used in the filter. - `filterType` 'EVENT', required — Indicates the type of filter being applied (EVENT). - `operator` string, required — Defines the operation to be applied within the event filter (HAS_EVENT, NOT_HAS_EVENT). - `pruningRefineBy` union — Specifies the criteria for refining the event filter by pruning. - … - PublicFormSubmissionFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION', required — Indicates the type of filter (FORM_SUBMISSION). - `formId` string — The ID of the form used in the filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be performed (FILLED_OUT, NOT_FILLED_OUT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicFormSubmissionOnPageFilter - `coalescingRefineBy` union — Defines the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION_ON_PAGE', required — Indicates the type of filter (FORM_SUBMISSION_ON_PAGE). - `formId` string — The ID of the form associated with the submission filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT). - `pageId` string, required — The ID of the page where the form submission occurred. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicIntegrationEventFilter - `eventTypeId` integer, required — The ID representing the type of event for the integration event filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'INTEGRATION_EVENT', required — Indicates the type of filter (INTEGRATION_EVENT). - PublicEmailSubscriptionFilter - `acceptedStatuses` string[], required - `filterType` 'EMAIL_SUBSCRIPTION', required — Indicates the type of filter (EMAIL_SUBSCRIPTION). - `subscriptionIds` string[], required - `subscriptionType` string — The type of subscription related to the filter (PORTAL, BRAND, SUBSCRIPTION, HARDBOUNCE, SPAMREPORT). - PublicCommunicationSubscriptionFilter - `acceptedOptStates` string[], required - `businessUnitId` string — The ID of the business unit associated with the subscription filter. - `channel` string, required — Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS). - `filterType` 'COMMUNICATION_SUBSCRIPTION', required — Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION) - `subscriptionIds` string[], required - `subscriptionType` string, required — Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION) - PublicCampaignInfluencedFilter - `campaignId` string, required — The ID of the campaign that influences the filter. - `filterType` 'CAMPAIGN_INFLUENCED', required — Indicates the type of filter (CAMPAIGN_INFLUENCED). - PublicSurveyMonkeyFilter - `filterType` 'SURVEY_MONKEY', required — Indicates the type of filter being applied (SURVEY_MONKEY). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_RESPONDED_TO_SURVEY, HAS_NOT_RESPONDED_TO_SURVEY). - `surveyId` string, required — The ID of the survey associated with the filter. - PublicSurveyMonkeyValueFilter - `filterType` 'SURVEY_MONKEY_VALUE', required — Defines the type of filter (SURVEY_MONKEY_VALUE). - `operator` string, required — Defines the operation to be applied within the filter (HAS_ANSWERED_SURVEY_QUESTION_WITH_VALUE). - `surveyAnswerColId` string — The column ID of the survey answer used in the filter. - `surveyAnswerRowId` string — The row ID of the survey answer used in the filter. - `surveyId` string, required — The ID of the survey used in the filter. - `surveyQuestion` string, required — The question from the survey used in the filter. - `valueComparison` union, required — Specifies the operation used to compare the survey answer value. - … - PublicWebinarFilter - `filterType` 'WEBINAR', required — Indicates the type of filter, (WEBINAR). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_WEBINAR_REGISTRATION, NOT_HAS_WEBINAR_REGISTRATION, HAS_WEBINAR_ATTENDANCE, NOT_HAS_WEBINAR_ATTENDANCE). - `webinarId` string — The ID of the webinar associated with the filter. - PublicEmailEventFilter - `appId` string, required — The ID of the application associated with the email event filter. - `clickUrl` string — The URL that was clicked in the email event. - `emailId` string, required — The ID of the email associated with the event filter. - `filterType` 'EMAIL_EVENT', required — Indicates the type of filter (EMAIL_EVENT). - `level` string, required — Specifies the level of the email event, such as EMAIL_API_CAMPAIGN_GROUP. - `operator` 'BOUNCED' | 'LINK_CLICKED' | 'MARKED_SPAM' | 'OPENED' | 'OPENED_BUT_LINK_NOT_CLICKED' | 'OPENED_BUT_NOT_REPLIED' | 'RECEIVED' | 'RECEIVED_BUT_NOT_OPENED' | 'REPLIED' | 'SENT' | 'SENT_BUT_LINK_NOT_CLICKED' | 'SENT_BUT_NOT_RECEIVED' | 'UNSUBSCRIBED', required — Defines the operation to be applied within the filter (BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPrivacyAnalyticsFilter - `filterType` 'PRIVACY', required — Specifies the type of filter (PRIVACY). - `operator` string, required — Defines the operation to be applied within the filter (PRIVACY_CONSENT_GRANTED, PRIVACY_CONSENT_NOT_GRANTED). - `privacyName` string, required — The name of the privacy setting used in the filter. - PublicAdsSearchFilter - `adNetwork` string, required — Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL) - `entityType` string, required — Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN) - `filterType` 'ADS_SEARCH', required — Type of the filter (ADS_SEARCH) - `operator` string, required — Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN) - `searchTermType` string, required — Search term to match an ad - `searchTerms` string[], required - PublicAdsTimeFilter - `filterType` 'ADS_TIME', required — Filter type (ADS_TIME) - `pruningRefineBy` union, required — Refinement criteria - … - PublicInListFilter - `filterType` 'IN_LIST', required — Indicates the type of filter being applied (IN_LIST). - `listId` string, required — The ID of the list used in the association filter. - `metadata` PublicInListFilterMetadata - … - `operator` string, required — Specifies the operation to be performed by the filter (IN_LIST, NOT_IN_LIST). - PublicNumAssociationsFilter - `associationCategory` string, required — Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'NUM_ASSOCIATIONS', required — Indicates the type of filter being applied (NUM_ASSOCIATIONS). - PublicUnifiedEventsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string — The identifier for the type of event in the unified events filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'UNIFIED_EVENTS', required — Indicates the type of filter being applied (UNIFIED_EVENTS). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPropertyAssociationInListFilter - `coalescingRefineBy` union, required — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'PROPERTY_ASSOCIATION', required — Indicates the type of filter being applied (PROPERTY_ASSOCIATION). - `listId` string, required — The ID of the list used in the property association filter. - `operator` string, required — Defines the operation to be applied by the filter (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property associated with the object ID in the filter. - `toObjectTypeId` string — The ID representing the type of object that the property association filter is targeting. - PublicConstantFilter - `filterType` 'CONSTANT', required — Specifies the type of filter, which is (CONSTANT). - `shouldAccept` boolean, required — Indicates whether the filter should accept the condition. - `source` string — Defines the source of the constant filter. - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property that is associated with the object ID in the filter branch. - PublicAssociationFilterBranch - `associationCategory` string, required — Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — Type id of the association - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'ASSOCIATION', required — Type of the filter branch (ASSOCIATION) - `filterBranches` union[], required - union - PublicOrFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine the filters within the branch (OR). - `filterBranchType` 'OR', required — The type of the filter branch (OR). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'AND', required — Type of filter branch (AND) - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — The operator used to combine filters within the branch (NOT_ALL). - `filterBranchType` 'NOT_ALL', required — The type of the filter branch (NOT_ALL). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Specifies the logical operator used to combine filters within the branch (NOT_ANY). - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch (NOT_ANY). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the restricted filter branch. - `filterBranchType` 'RESTRICTED', required — Specifies the type of the filter branch (RESTRICTED). - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string, required — The identifier for the type of event associated with the filter branch. - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch (AND). - `filterBranchType` 'UNIFIED_EVENTS', required — The type of the filter branch (UNIFIED_EVENTS). - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Defines the operation to be applied within the filter branch (HAS_COMPLETED, HAS_NOT_COMPLETED). - `pruningRefineBy` union - … - PublicPropertyAssociationFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch. - `filterBranchType` 'PROPERTY_ASSOCIATION', required — The type of the filter branch (PROPERTY_ASSOCIATION). - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property that is associated with the object ID in the filter branch. - PublicAssociationFilterBranch — recursive - `filters` union[], required - union - PublicPropertyFilter - `filterType` 'PROPERTY', required — Indicates that the filter (PROPERTY). - `operation` union, required — Defines the operation to be performed on the property, such as comparison or value matching. - … - `property` string, required — Specifies the name of the property that the filter is applied to. - PublicAssociationInListFilter - `associationCategory` string, required — Defines the category of the association, such as (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'ASSOCIATION', required — Indicates the type of filter being applied, which is 'ASSOCIATION' by default. - `listId` string, required — The ID of the list used in the association filter. - `operator` string, required — Specifies the operation to be performed by the filter, such as 'IN_LIST' or 'NOT_IN_LIST'. - `toObjectType` string — The type of object that the association filter is targeting. - `toObjectTypeId` string — The ID representing the type of object that the association filter is targeting. - PublicPageViewAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `enableTracking` boolean — Indicates whether tracking is enabled for the page view. - `filterType` 'PAGE_VIEW', required — Indicates the type of filter being applied (PAGE_VIEW). - `operator` string, required — Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS). - `pageUrl` string, required — The URL of the page to be used in the filter. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicCtaAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `ctaName` string, required — The name of the Call-to-Action (CTA) to be used in the filter. - `filterType` 'CTA', required — Indicates the type of filter being applied, which is (CTA). - `operator` string, required — Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicEventAnalyticsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the event filter by coalescing. - … - `eventId` string, required — The ID of the event to be used in the filter. - `filterType` 'EVENT', required — Indicates the type of filter being applied (EVENT). - `operator` string, required — Defines the operation to be applied within the event filter (HAS_EVENT, NOT_HAS_EVENT). - `pruningRefineBy` union — Specifies the criteria for refining the event filter by pruning. - … - PublicFormSubmissionFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION', required — Indicates the type of filter (FORM_SUBMISSION). - `formId` string — The ID of the form used in the filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be performed (FILLED_OUT, NOT_FILLED_OUT). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicFormSubmissionOnPageFilter - `coalescingRefineBy` union — Defines the criteria for refining the filter by coalescing. - … - `filterType` 'FORM_SUBMISSION_ON_PAGE', required — Indicates the type of filter (FORM_SUBMISSION_ON_PAGE). - `formId` string — The ID of the form associated with the submission filter. - `operator` 'FILLED_OUT' | 'NOT_FILLED_OUT', required — Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT). - `pageId` string, required — The ID of the page where the form submission occurred. - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicIntegrationEventFilter - `eventTypeId` integer, required — The ID representing the type of event for the integration event filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'INTEGRATION_EVENT', required — Indicates the type of filter (INTEGRATION_EVENT). - PublicEmailSubscriptionFilter - `acceptedStatuses` string[], required - `filterType` 'EMAIL_SUBSCRIPTION', required — Indicates the type of filter (EMAIL_SUBSCRIPTION). - `subscriptionIds` string[], required - `subscriptionType` string — The type of subscription related to the filter (PORTAL, BRAND, SUBSCRIPTION, HARDBOUNCE, SPAMREPORT). - PublicCommunicationSubscriptionFilter - `acceptedOptStates` string[], required - `businessUnitId` string — The ID of the business unit associated with the subscription filter. - `channel` string, required — Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS). - `filterType` 'COMMUNICATION_SUBSCRIPTION', required — Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION) - `subscriptionIds` string[], required - `subscriptionType` string, required — Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION) - PublicCampaignInfluencedFilter - `campaignId` string, required — The ID of the campaign that influences the filter. - `filterType` 'CAMPAIGN_INFLUENCED', required — Indicates the type of filter (CAMPAIGN_INFLUENCED). - PublicSurveyMonkeyFilter - `filterType` 'SURVEY_MONKEY', required — Indicates the type of filter being applied (SURVEY_MONKEY). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_RESPONDED_TO_SURVEY, HAS_NOT_RESPONDED_TO_SURVEY). - `surveyId` string, required — The ID of the survey associated with the filter. - PublicSurveyMonkeyValueFilter - `filterType` 'SURVEY_MONKEY_VALUE', required — Defines the type of filter (SURVEY_MONKEY_VALUE). - `operator` string, required — Defines the operation to be applied within the filter (HAS_ANSWERED_SURVEY_QUESTION_WITH_VALUE). - `surveyAnswerColId` string — The column ID of the survey answer used in the filter. - `surveyAnswerRowId` string — The row ID of the survey answer used in the filter. - `surveyId` string, required — The ID of the survey used in the filter. - `surveyQuestion` string, required — The question from the survey used in the filter. - `valueComparison` union, required — Specifies the operation used to compare the survey answer value. - … - PublicWebinarFilter - `filterType` 'WEBINAR', required — Indicates the type of filter, (WEBINAR). - `operator` string, required — Specifies the operation to be performed by the filter (HAS_WEBINAR_REGISTRATION, NOT_HAS_WEBINAR_REGISTRATION, HAS_WEBINAR_ATTENDANCE, NOT_HAS_WEBINAR_ATTENDANCE). - `webinarId` string — The ID of the webinar associated with the filter. - PublicEmailEventFilter - `appId` string, required — The ID of the application associated with the email event filter. - `clickUrl` string — The URL that was clicked in the email event. - `emailId` string, required — The ID of the email associated with the event filter. - `filterType` 'EMAIL_EVENT', required — Indicates the type of filter (EMAIL_EVENT). - `level` string, required — Specifies the level of the email event, such as EMAIL_API_CAMPAIGN_GROUP. - `operator` 'BOUNCED' | 'LINK_CLICKED' | 'MARKED_SPAM' | 'OPENED' | 'OPENED_BUT_LINK_NOT_CLICKED' | 'OPENED_BUT_NOT_REPLIED' | 'RECEIVED' | 'RECEIVED_BUT_NOT_OPENED' | 'REPLIED' | 'SENT' | 'SENT_BUT_LINK_NOT_CLICKED' | 'SENT_BUT_NOT_RECEIVED' | 'UNSUBSCRIBED', required — Defines the operation to be applied within the filter (BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPrivacyAnalyticsFilter - `filterType` 'PRIVACY', required — Specifies the type of filter (PRIVACY). - `operator` string, required — Defines the operation to be applied within the filter (PRIVACY_CONSENT_GRANTED, PRIVACY_CONSENT_NOT_GRANTED). - `privacyName` string, required — The name of the privacy setting used in the filter. - PublicAdsSearchFilter - `adNetwork` string, required — Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL) - `entityType` string, required — Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN) - `filterType` 'ADS_SEARCH', required — Type of the filter (ADS_SEARCH) - `operator` string, required — Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN) - `searchTermType` string, required — Search term to match an ad - `searchTerms` string[], required - PublicAdsTimeFilter - `filterType` 'ADS_TIME', required — Filter type (ADS_TIME) - `pruningRefineBy` union, required — Refinement criteria - … - PublicInListFilter - `filterType` 'IN_LIST', required — Indicates the type of filter being applied (IN_LIST). - `listId` string, required — The ID of the list used in the association filter. - `metadata` PublicInListFilterMetadata - … - `operator` string, required — Specifies the operation to be performed by the filter (IN_LIST, NOT_IN_LIST). - PublicNumAssociationsFilter - `associationCategory` string, required — Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — The ID representing the type of association being filtered. - `coalescingRefineBy` union, required — Specifies the criteria for refining the association filter. - … - `filterType` 'NUM_ASSOCIATIONS', required — Indicates the type of filter being applied (NUM_ASSOCIATIONS). - PublicUnifiedEventsFilter - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - … - `eventTypeId` string — The identifier for the type of event in the unified events filter. - `filterLines` PublicEventFilterMetadata[], required - … - `filterType` 'UNIFIED_EVENTS', required — Indicates the type of filter being applied (UNIFIED_EVENTS). - `pruningRefineBy` union — Specifies the criteria for refining the filter by pruning. - … - PublicPropertyAssociationInListFilter - `coalescingRefineBy` union, required — Specifies the criteria for refining the filter by coalescing. - … - `filterType` 'PROPERTY_ASSOCIATION', required — Indicates the type of filter being applied (PROPERTY_ASSOCIATION). - `listId` string, required — The ID of the list used in the property association filter. - `operator` string, required — Defines the operation to be applied by the filter (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property associated with the object ID in the filter. - `toObjectTypeId` string — The ID representing the type of object that the property association filter is targeting. - PublicConstantFilter - `filterType` 'CONSTANT', required — Specifies the type of filter, which is (CONSTANT). - `shouldAccept` boolean, required — Indicates whether the filter should accept the condition. - `source` string — Defines the source of the constant filter. - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `listFolderId` integer — The ID of the folder that the list should be created in. If left blank, then the list will be created in the root of the list folder structure. - `listPermissions` PublicListPermissions - `teamsWithEditAccess` integer[], required - `usersWithEditAccess` integer[], required - `membershipSettings` PublicMembershipSettings - `includeUnassigned` boolean — Indicates whether unassigned memberships should be included. - `membershipTeamId` integer — The ID of the team associated with the membership. - `name` string, required — The name of the list, which must be globally unique across all public lists in the portal. - `objectTypeId` string, required — The object type ID of the type of objects that the list will store. - `processingType` string, required — The processing type of the list. One of: `SNAPSHOT`, `MANUAL`, or `DYNAMIC`. ## Response `200` successful operation - ListCreateResponse - `list` PublicObjectList, required - `createdAt` string, date-time — The time when the list was created. - `createdById` string — The ID of the user that created the list. - `deletedAt` string, date-time — The time when the list was deleted. - `filterBranch` union — Defines the filter criteria for the list, allowing for complex logical operations and nested filter branches to determine list membership. - PublicOrFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine the filters within the branch (OR). - `filterBranchType` 'OR', required — The type of the filter branch (OR). - `filterBranches` union[], required - union - PublicOrFilterBranch — recursive - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicPropertyAssociationFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicCampaignInfluencedFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicNumAssociationsFilter - … - PublicUnifiedEventsFilter - … - PublicPropertyAssociationInListFilter - … - PublicConstantFilter - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'AND', required — Type of filter branch (AND) - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch — recursive - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicPropertyAssociationFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicCampaignInfluencedFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicNumAssociationsFilter - … - PublicUnifiedEventsFilter - … - PublicPropertyAssociationInListFilter - … - PublicConstantFilter - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — The operator used to combine filters within the branch (NOT_ALL). - `filterBranchType` 'NOT_ALL', required — The type of the filter branch (NOT_ALL). - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch — recursive - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicPropertyAssociationFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicCampaignInfluencedFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicNumAssociationsFilter - … - PublicUnifiedEventsFilter - … - PublicPropertyAssociationInListFilter - … - PublicConstantFilter - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Specifies the logical operator used to combine filters within the branch (NOT_ANY). - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch (NOT_ANY). - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch — recursive - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicPropertyAssociationFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicCampaignInfluencedFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicNumAssociationsFilter - … - PublicUnifiedEventsFilter - … - PublicPropertyAssociationInListFilter - … - PublicConstantFilter - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the restricted filter branch. - `filterBranchType` 'RESTRICTED', required — Specifies the type of the filter branch (RESTRICTED). - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch — recursive - PublicUnifiedEventsFilterBranch - … - PublicPropertyAssociationFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicCampaignInfluencedFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicNumAssociationsFilter - … - PublicUnifiedEventsFilter - … - PublicPropertyAssociationInListFilter - … - PublicConstantFilter - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Specifies the criteria for refining the filter by coalescing. - PublicNumOccurrencesRefineBy - `maxOccurrences` integer — The maximum number of occurrences allowed. - `minOccurrences` integer — The minimum number of occurrences required. - `type` 'NUM_OCCURRENCES', required — The type of refinement (NUM_OCCURRENCES). - PublicSetOccurrencesRefineBy - `setType` string, required — Indicates the specific set type used in the refinement (ALL, ALL_INCLUDE_EMPTY, ANY, NONE, NONE_EXCLUDE_EMPTY, ANY_INCLUDE_EMPTY). - `type` 'SET_OCCURRENCES', required — Specifies the type of refinement (SET_OCCURRENCES). - PublicRelativeComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation to be used in the refinement (BEFORE, AFTER). - `timeOffset` PublicTimeOffset, required - … - `type` 'RELATIVE_COMPARATIVE', required — Specifies the type of refinement, (RELATIVE_COMPARATIVE). - PublicRelativeRangedTimestampRefineBy - `lowerBoundOffset` PublicTimeOffset, required - … - `rangeType` string, required — Specifies the type of range for the refinement criteria (BETWEEN, NOT_BETWEEN). - `type` 'RELATIVE_RANGED', required — Indicates the type of refinement (RELATIVE_RANGED). - `upperBoundOffset` PublicTimeOffset, required - … - PublicAbsoluteComparativeTimestampRefineBy - `comparison` string, required — Timestamp comparison options (BEFORE, AFTER) - `timestamp` integer, required — Timestamp to be used in refine by criteria - `type` 'ABSOLUTE_COMPARATIVE', required — type of refine by criteria (ABSOLUTE_COMPARATIVE) - PublicAbsoluteRangedTimestampRefineBy - `lowerTimestamp` integer, required — Lower range timestamp of refinement criteria - `rangeType` string, required — Type of range of refinement critaria (BETWEEN, NOT_BETWEEN) - `type` 'ABSOLUTE_RANGED', required — type of refine by criteria (ABSOLUTE_RANGED) - `upperTimestamp` integer, required — Upper range timestamp of refinement criteria - PublicAllHistoryRefineBy - `type` 'ALL_HISTORY', required — Type of refine by (ALL_HISTORY) - PublicTimePointOperation - `endpointBehavior` string — Describes the behavior at the endpoint of the time point operation. - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects with no value set for the property should be included in the operation. - `operationType` 'TIME_POINT', required — Specifies the type of operation (TIME_POINT). - `operator` string, required — Specifies the operation to be applied within the time point operation (IS_BEFORE, IS_AFTER). - `propertyParser` string — Specifies the parser used for interpreting the property in the operation. - `timePoint` union, required — Defines the specific point in time for the operation, which can be a date, indexed time, or property-referenced time. - … - `type` string, required — Defines the type of operation being performed. - PublicRangedTimeOperation - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects with no value set for the property should be included in the operation. - `lowerBoundEndpointBehavior` string — Describes the behavior at the lower bound endpoint of the time range. - `lowerBoundTimePoint` union, required — Defines the lower bound time point for the operation. - … - `operationType` string, required — Specifies the type of operation (TIME_RANGED). - `operator` string, required — Defines the operation to be applied within the time range (IS_BETWEEN, IS_NOT_BETWEEN). - `propertyParser` string — Specifies the parser used for the property in the operation. - `type` 'TIME_RANGED', required — Specifies the type of operation (TIME_RANGED). - `upperBoundEndpointBehavior` string — Describes the behavior at the upper bound endpoint of the time range. - `upperBoundTimePoint` union, required — Defines the upper bound time point for the operation. - … - `eventTypeId` string, required — The identifier for the type of event associated with the filter branch. - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch (AND). - `filterBranchType` 'UNIFIED_EVENTS', required — The type of the filter branch (UNIFIED_EVENTS). - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch — recursive - PublicPropertyAssociationFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicCampaignInfluencedFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicNumAssociationsFilter - … - PublicUnifiedEventsFilter - … - PublicPropertyAssociationInListFilter - … - PublicConstantFilter - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Defines the operation to be applied within the filter branch (HAS_COMPLETED, HAS_NOT_COMPLETED). - `pruningRefineBy` union - PublicNumOccurrencesRefineBy - `maxOccurrences` integer — The maximum number of occurrences allowed. - `minOccurrences` integer — The minimum number of occurrences required. - `type` 'NUM_OCCURRENCES', required — The type of refinement (NUM_OCCURRENCES). - PublicSetOccurrencesRefineBy - `setType` string, required — Indicates the specific set type used in the refinement (ALL, ALL_INCLUDE_EMPTY, ANY, NONE, NONE_EXCLUDE_EMPTY, ANY_INCLUDE_EMPTY). - `type` 'SET_OCCURRENCES', required — Specifies the type of refinement (SET_OCCURRENCES). - PublicRelativeComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation to be used in the refinement (BEFORE, AFTER). - `timeOffset` PublicTimeOffset, required - … - `type` 'RELATIVE_COMPARATIVE', required — Specifies the type of refinement, (RELATIVE_COMPARATIVE). - PublicRelativeRangedTimestampRefineBy - `lowerBoundOffset` PublicTimeOffset, required - … - `rangeType` string, required — Specifies the type of range for the refinement criteria (BETWEEN, NOT_BETWEEN). - `type` 'RELATIVE_RANGED', required — Indicates the type of refinement (RELATIVE_RANGED). - `upperBoundOffset` PublicTimeOffset, required - … - PublicAbsoluteComparativeTimestampRefineBy - `comparison` string, required — Timestamp comparison options (BEFORE, AFTER) - `timestamp` integer, required — Timestamp to be used in refine by criteria - `type` 'ABSOLUTE_COMPARATIVE', required — type of refine by criteria (ABSOLUTE_COMPARATIVE) - PublicAbsoluteRangedTimestampRefineBy - `lowerTimestamp` integer, required — Lower range timestamp of refinement criteria - `rangeType` string, required — Type of range of refinement critaria (BETWEEN, NOT_BETWEEN) - `type` 'ABSOLUTE_RANGED', required — type of refine by criteria (ABSOLUTE_RANGED) - `upperTimestamp` integer, required — Upper range timestamp of refinement criteria - PublicAllHistoryRefineBy - `type` 'ALL_HISTORY', required — Type of refine by (ALL_HISTORY) - PublicTimePointOperation - `endpointBehavior` string — Describes the behavior at the endpoint of the time point operation. - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects with no value set for the property should be included in the operation. - `operationType` 'TIME_POINT', required — Specifies the type of operation (TIME_POINT). - `operator` string, required — Specifies the operation to be applied within the time point operation (IS_BEFORE, IS_AFTER). - `propertyParser` string — Specifies the parser used for interpreting the property in the operation. - `timePoint` union, required — Defines the specific point in time for the operation, which can be a date, indexed time, or property-referenced time. - … - `type` string, required — Defines the type of operation being performed. - PublicRangedTimeOperation - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects with no value set for the property should be included in the operation. - `lowerBoundEndpointBehavior` string — Describes the behavior at the lower bound endpoint of the time range. - `lowerBoundTimePoint` union, required — Defines the lower bound time point for the operation. - … - `operationType` string, required — Specifies the type of operation (TIME_RANGED). - `operator` string, required — Defines the operation to be applied within the time range (IS_BETWEEN, IS_NOT_BETWEEN). - `propertyParser` string — Specifies the parser used for the property in the operation. - `type` 'TIME_RANGED', required — Specifies the type of operation (TIME_RANGED). - `upperBoundEndpointBehavior` string — Describes the behavior at the upper bound endpoint of the time range. - `upperBoundTimePoint` union, required — Defines the upper bound time point for the operation. - … - PublicPropertyAssociationFilterBranch - `filterBranchOperator` string, required — The logical operator used to combine filters within the branch. - `filterBranchType` 'PROPERTY_ASSOCIATION', required — The type of the filter branch (PROPERTY_ASSOCIATION). - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicPropertyAssociationFilterBranch — recursive - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicCampaignInfluencedFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicNumAssociationsFilter - … - PublicUnifiedEventsFilter - … - PublicPropertyAssociationInListFilter - … - PublicConstantFilter - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `propertyWithObjectId` string, required — The property that is associated with the object ID in the filter branch. - PublicAssociationFilterBranch - `associationCategory` string, required — Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). - `associationTypeId` integer, required — Type id of the association - `filterBranchOperator` string, required — Filter branch operator (AND) - `filterBranchType` 'ASSOCIATION', required — Type of the filter branch (ASSOCIATION) - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicPropertyAssociationFilterBranch - … - PublicAssociationFilterBranch — recursive - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicCampaignInfluencedFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicNumAssociationsFilter - … - PublicUnifiedEventsFilter - … - PublicPropertyAssociationInListFilter - … - PublicConstantFilter - … - `objectTypeId` string, required — The ID representing the type of object associated with the filter branch. - `operator` string, required — Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). - `filtersUpdatedAt` string, date-time — The time when the filters for this list were last updated. - `listId` string, required — The **ILS ID** of the list. - `listPermissions` PublicListPermissions - `teamsWithEditAccess` integer[], required - `usersWithEditAccess` integer[], required - `listVersion` integer, required — The version of the list. - `membershipSettings` PublicMembershipSettings - `includeUnassigned` boolean — Indicates whether unassigned memberships should be included. - `membershipTeamId` integer — The ID of the team associated with the membership. - `name` string, required — The name of the list. - `objectTypeId` string, required — The object type of the list. - `processingStatus` string, required — The processing status of the list. - `processingType` string, required — The processing type of the list. - `size` integer — Size of the list - `updatedAt` string, date-time — The time the list was last updated. - `updatedById` string — The ID of the user that last updated the list. ## Other responses - `default` — An error occurred. --- [API](https://skmtc.net/hubspot/apis/crm-lists.md) · [All operations](https://skmtc.net/hubspot/apis/crm-lists/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hubspot/crm-lists/versions/768fc0c2673a/schema)