> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get an event definition > Retrieve the definition of a specific behavioral event in your HubSpot account by providing the event name. This endpoint returns detailed information about the event type, including its properties and associations. > [accordion] Supported products > [accordion] Required Scopes ## OpenAPI ````yaml specs/2026-09/events-manage-event-definitions-v2026-09.json GET /events/2026-09/event-definitions/{eventName} openapi: 3.0.1 info: title: Events Manage Event Definitions description: Basepom for all HubSpot Projects version: 2026-09 x-hubspot-product-tier-requirements: marketing: ENTERPRISE sales: ENTERPRISE service: ENTERPRISE cms: ENTERPRISE commerce: ENTERPRISE crmHub: ENTERPRISE dataHub: ENTERPRISE servers: - url: https://api.hubapi.com security: [] tags: - name: Advanced - name: Basic paths: /events/2026-09/event-definitions/{eventName}: get: tags: - Basic summary: Retrieve event definition description: >- Retrieve the definition of a specific behavioral event in your HubSpot account by providing the event name. This endpoint returns detailed information about the event type, including its properties and associations. operationId: get-/events/2026-09/event-definitions/{eventName} parameters: - name: eventName in: path description: The unique name of the event definition to retrieve. required: true style: simple explode: false schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ExternalBehavioralEventTypeDefinition' default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - behavioral_events.event_definitions.read_write components: schemas: ExternalBehavioralEventTypeDefinition: required: - archived - associations - fullyQualifiedName - id - labels - name - objectTypeId - properties type: object properties: archived: type: boolean description: A boolean indicating whether the event type is archived. associations: type: array description: An array of association definitions related to the event type. items: $ref: '#/components/schemas/AssociationDefinition' comboEventRules: $ref: '#/components/schemas/ComboEventRuleBranch' createdAt: type: string description: >- A string representing the date and time when the event type was created, in ISO 8601 format. format: date-time createdUserId: type: integer description: >- An integer representing the ID of the user who created the event type. format: int32 customMatchingId: $ref: '#/components/schemas/ExternalObjectResolutionMappingResponse' description: type: string description: A string providing a description of the event type. detailTemplate: type: string description: >- The rendering template for the body of the CRM timeline activity card. fullyQualifiedName: type: string description: A string representing the fully qualified name of the event type. headerTemplate: type: string description: >- The rendering template for the header of the CRM timeline activity card. id: type: string description: A string representing the unique identifier of the event type. labels: $ref: '#/components/schemas/BehavioralEventTypeDefinitionLabels' name: type: string description: A string representing the name of the event type. objectTypeId: type: string description: >- A string representing the object type ID associated with the event type. primaryObject: type: string description: >- A string representing the primary object associated with the event type. primaryObjectId: type: string description: >- A string representing the ID of the primary object associated with the event type. properties: type: array description: An array of property objects associated with the event type. items: $ref: '#/components/schemas/Property' trackingType: type: string description: >- A string indicating the tracking type of the event. Valid values include 'VISITED_URL', 'CLICKED_ELEMENT', 'CUSTOM_SCRIPT', 'MANUAL', 'IMPORT', 'PROPERTY_CHANGE', 'COMBO_EVENT'. enum: - APP_EVENT - AUTOCAPTURE_EVENT - CLICKED_ELEMENT - COMBO_EVENT - CUSTOM_SCRIPT - CUSTOM_SIGNAL - IMPORT - MANUAL - POLLING - PROPERTY_CHANGE - VISITED_URL - WEBHOOK updatedAt: type: string description: >- A string representing the date and time when the event type was last updated, in ISO 8601 format. format: date-time updatedUserId: type: integer description: >- An integer representing the ID of the user who last updated the event type. format: int32 AssociationDefinition: required: - allowsCustomLabels - cardinality - category - fromObjectTypeId - hasAllAssociatedObjects - hasCascadingDeletes - hasUserEnforcedMaxFromObjectIds - hasUserEnforcedMaxToObjectIds - hidden - id - inverseAllowsCustomLabels - inverseCardinality - inverseHasAllAssociatedObjects - inverseId - inverseName - isDefault - isInversePrimary - isPrimary - maxFromObjectIds - maxToObjectIds - name - portalUniqueIdentifier - readOnly - toObjectTypeId type: object properties: allowsCustomLabels: type: boolean description: >- A boolean indicating if custom labels are allowed for this association. cardinality: type: string description: >- The nature of the association in terms of cardinality, which can be 'ONE_TO_ONE' or 'ONE_TO_MANY'. enum: - ONE_TO_MANY - ONE_TO_ONE category: type: string description: >- The category of the association, indicating whether it is defined by HubSpot, the user, an integrator, or for work purposes. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. enum: - HUBSPOT_DEFINED - INTEGRATOR_DEFINED - USER_DEFINED - WORK fromObjectType: type: string description: >- The type of object from which the association originates. Valid values include various HubSpot object types such as 'CONTACT', 'COMPANY', 'DEAL', etc. enum: - ABANDONED_CART - ACCEPTANCE_TEST - AD - AD_ACCOUNT - AD_CAMPAIGN - AD_GROUP - AI_FORECAST - ALL_PAGES - APPROVAL - APPROVAL_STEP - ATTRIBUTION - AUDIENCE - AUTOMATION_JOURNEY - AUTOMATION_PLATFORM_FLOW - AUTOMATION_PLATFORM_FLOW_ACTION - BET_ALERT - BET_DELIVERABLE_SERVICE - BLOG_LISTING_PAGE - BLOG_POST - CALL - CAMPAIGN - CAMPAIGN_BUDGET_ITEM - CAMPAIGN_SPEND_ITEM - CAMPAIGN_STEP - CAMPAIGN_TEMPLATE - CAMPAIGN_TEMPLATE_STEP - CART - CASE_STUDY - CHATFLOW - CLIP - CMS_URL - COMBO_EVENT_CONFIGURATION - COMMERCE_PAYMENT - COMMUNICATION - COMPANY - CONTACT - CONTACT_CREATE_ATTRIBUTION - CONTENT - CONTENT_AUDIT - CONTENT_AUDIT_PAGE - CONVERSATION - CONVERSATION_INBOX - CONVERSATION_SESSION - CRM_OBJECTS_DUMMY_TYPE - CRM_PIPELINES_DUMMY_TYPE - CTA - CTA_VARIANT - DATA_PRIVACY_CONSENT - DATA_SYNC_STATE - DEAL - DEAL_CREATE_ATTRIBUTION - DEAL_REGISTRATION - DEAL_SPLIT - DISCOUNT - DISCOUNT_CODE - DISCOUNT_TEMPLATE - EMAIL - ENGAGEMENT - EXPORT - EXTERNAL_WEB_URL - FEE - FEEDBACK_SUBMISSION - FEEDBACK_SURVEY - FILE_MANAGER_FILE - FILE_MANAGER_FOLDER - FOLDER - FORECAST - FORM - FORM_SUBMISSION_INBOUNDDB - GOAL_TARGET - GOAL_TARGET_GROUP - GOAL_TEMPLATE - GSC_PROPERTY - HUB - IMPORT - INVOICE - KEYWORD - KNOWLEDGE_ARTICLE - LANDING_PAGE - LEAD - LINE_ITEM - MARKETING_CALENDAR - MARKETING_CAMPAIGN_UTM - MARKETING_EMAIL - MARKETING_EVENT - MARKETING_EVENT_ATTENDANCE - MARKETING_SMS - MEDIA_BRIDGE - MEETING_EVENT - MIC - NOTE - OBJECT_LIST - ORDER - OWNER - PARTNER_ACCOUNT - PARTNER_CLIENT - PARTNER_CLIENT_REVENUE - PARTNER_SERVICE - PAYMENT_LINK - PAYMENT_SCHEDULE - PAYMENT_SCHEDULE_INSTALLMENT - PERMISSIONS_TESTING - PLAYBOOK - PLAYBOOK_QUESTION - PLAYBOOK_SUBMISSION - PLAYBOOK_SUBMISSION_ANSWER - PLAYLIST - PLAYLIST_FOLDER - PODCAST_EPISODE - PORTAL - PORTAL_OBJECT_SYNC_MESSAGE - POSTAL_MAIL - PRIVACY_SCANNER_COOKIE - PRODUCT - PRODUCT_OR_FOLDER - PROPERTY_INFO - PROSPECTING_AGENT_CONTACT_ASSIGNMENT - PUBLISHING_TASK - QUARANTINED_SUBMISSION - QUOTA - QUOTE - QUOTE_FIELD - QUOTE_MODULE - QUOTE_MODULE_FIELD - QUOTE_TEMPLATE - RESTORABLE_CRM_OBJECT - ROSTER - ROSTER_MEMBER - SALES_DOCUMENT - SALES_TASK - SALES_WORKLOAD - SALESFORCE_SYNC_ERROR - SCHEDULING_PAGE - SCHEMAS_BACKEND_TEST - SCORE_CONFIGURATION - SEQUENCE - SEQUENCE_ENROLLMENT - SEQUENCE_STEP - SEQUENCE_STEP_ENROLLMENT - SERVICE - SITE_PAGE - SNIPPET - SOCIAL_BROADCAST - SOCIAL_CHANNEL - SOCIAL_POST - SOCIAL_PROFILE - SOX_PROTECTED_DUMMY_TYPE - SOX_PROTECTED_TEST_TYPE - SUBMISSION_TAG - SUBSCRIPTION - TASK - TASK_TEMPLATE - TAX - TEMPLATE - TICKET - UNKNOWN - UNSUBSCRIBE - USER - VIEW - VIEW_BLOCK - WEB_INTERACTIVE fromObjectTypeId: type: string description: The object type ID from which the association originates. hasAllAssociatedObjects: type: boolean description: >- A boolean indicating if all associated objects are included in the association. hasCascadingDeletes: type: boolean description: >- A boolean indicating if cascading deletes are enabled for this association. hasUserEnforcedMaxFromObjectIds: type: boolean description: >- A boolean indicating if there is a user-enforced maximum on the number of 'from' object IDs. hasUserEnforcedMaxToObjectIds: type: boolean description: >- A boolean indicating if there is a user-enforced maximum on the number of 'to' object IDs. hidden: type: boolean description: A boolean indicating if the association is hidden. hiddenReason: type: string description: >- The reason why the association is hidden, if applicable. Valid values include 'DEFAULT', 'INTERNAL', and 'USER_CONFIGURED'. enum: - DEFAULT - INTERNAL - USER_CONFIGURED id: type: integer description: The unique identifier for this association definition. format: int32 inverseAllowsCustomLabels: type: boolean description: >- A boolean indicating if custom labels are allowed for the inverse association. inverseCardinality: type: string description: >- The cardinality of the inverse association, which can also be 'ONE_TO_ONE' or 'ONE_TO_MANY'. enum: - ONE_TO_MANY - ONE_TO_ONE inverseHasAllAssociatedObjects: type: boolean description: >- A boolean indicating if all associated objects are included in the inverse association. inverseId: type: integer description: >- The unique identifier for the inverse of this association definition. format: int32 inverseLabel: type: string description: A human-readable label for the inverse association. inverseName: type: string description: The name of the inverse association. isDefault: type: boolean description: A boolean indicating if this association is the default association. isInversePrimary: type: boolean description: >- A boolean indicating if the inverse association is the primary association. isPrimary: type: boolean description: A boolean indicating if this association is the primary association. label: type: string description: A human-readable label for the association. maxFromObjectIds: type: integer description: >- The maximum number of object IDs that can be associated in the 'from' direction. format: int32 maxToObjectIds: type: integer description: >- The maximum number of object IDs that can be associated in the 'to' direction. format: int32 name: type: string description: The name of the association. portalUniqueIdentifier: type: string description: A unique identifier for the association within the portal. readOnly: type: boolean description: A boolean indicating if the association is read-only. toObjectType: type: string description: >- The type of object to which the association points. Valid values include various HubSpot object types such as 'CONTACT', 'COMPANY', 'DEAL', etc. enum: - ABANDONED_CART - ACCEPTANCE_TEST - AD - AD_ACCOUNT - AD_CAMPAIGN - AD_GROUP - AI_FORECAST - ALL_PAGES - APPROVAL - APPROVAL_STEP - ATTRIBUTION - AUDIENCE - AUTOMATION_JOURNEY - AUTOMATION_PLATFORM_FLOW - AUTOMATION_PLATFORM_FLOW_ACTION - BET_ALERT - BET_DELIVERABLE_SERVICE - BLOG_LISTING_PAGE - BLOG_POST - CALL - CAMPAIGN - CAMPAIGN_BUDGET_ITEM - CAMPAIGN_SPEND_ITEM - CAMPAIGN_STEP - CAMPAIGN_TEMPLATE - CAMPAIGN_TEMPLATE_STEP - CART - CASE_STUDY - CHATFLOW - CLIP - CMS_URL - COMBO_EVENT_CONFIGURATION - COMMERCE_PAYMENT - COMMUNICATION - COMPANY - CONTACT - CONTACT_CREATE_ATTRIBUTION - CONTENT - CONTENT_AUDIT - CONTENT_AUDIT_PAGE - CONVERSATION - CONVERSATION_INBOX - CONVERSATION_SESSION - CRM_OBJECTS_DUMMY_TYPE - CRM_PIPELINES_DUMMY_TYPE - CTA - CTA_VARIANT - DATA_PRIVACY_CONSENT - DATA_SYNC_STATE - DEAL - DEAL_CREATE_ATTRIBUTION - DEAL_REGISTRATION - DEAL_SPLIT - DISCOUNT - DISCOUNT_CODE - DISCOUNT_TEMPLATE - EMAIL - ENGAGEMENT - EXPORT - EXTERNAL_WEB_URL - FEE - FEEDBACK_SUBMISSION - FEEDBACK_SURVEY - FILE_MANAGER_FILE - FILE_MANAGER_FOLDER - FOLDER - FORECAST - FORM - FORM_SUBMISSION_INBOUNDDB - GOAL_TARGET - GOAL_TARGET_GROUP - GOAL_TEMPLATE - GSC_PROPERTY - HUB - IMPORT - INVOICE - KEYWORD - KNOWLEDGE_ARTICLE - LANDING_PAGE - LEAD - LINE_ITEM - MARKETING_CALENDAR - MARKETING_CAMPAIGN_UTM - MARKETING_EMAIL - MARKETING_EVENT - MARKETING_EVENT_ATTENDANCE - MARKETING_SMS - MEDIA_BRIDGE - MEETING_EVENT - MIC - NOTE - OBJECT_LIST - ORDER - OWNER - PARTNER_ACCOUNT - PARTNER_CLIENT - PARTNER_CLIENT_REVENUE - PARTNER_SERVICE - PAYMENT_LINK - PAYMENT_SCHEDULE - PAYMENT_SCHEDULE_INSTALLMENT - PERMISSIONS_TESTING - PLAYBOOK - PLAYBOOK_QUESTION - PLAYBOOK_SUBMISSION - PLAYBOOK_SUBMISSION_ANSWER - PLAYLIST - PLAYLIST_FOLDER - PODCAST_EPISODE - PORTAL - PORTAL_OBJECT_SYNC_MESSAGE - POSTAL_MAIL - PRIVACY_SCANNER_COOKIE - PRODUCT - PRODUCT_OR_FOLDER - PROPERTY_INFO - PROSPECTING_AGENT_CONTACT_ASSIGNMENT - PUBLISHING_TASK - QUARANTINED_SUBMISSION - QUOTA - QUOTE - QUOTE_FIELD - QUOTE_MODULE - QUOTE_MODULE_FIELD - QUOTE_TEMPLATE - RESTORABLE_CRM_OBJECT - ROSTER - ROSTER_MEMBER - SALES_DOCUMENT - SALES_TASK - SALES_WORKLOAD - SALESFORCE_SYNC_ERROR - SCHEDULING_PAGE - SCHEMAS_BACKEND_TEST - SCORE_CONFIGURATION - SEQUENCE - SEQUENCE_ENROLLMENT - SEQUENCE_STEP - SEQUENCE_STEP_ENROLLMENT - SERVICE - SITE_PAGE - SNIPPET - SOCIAL_BROADCAST - SOCIAL_CHANNEL - SOCIAL_POST - SOCIAL_PROFILE - SOX_PROTECTED_DUMMY_TYPE - SOX_PROTECTED_TEST_TYPE - SUBMISSION_TAG - SUBSCRIPTION - TASK - TASK_TEMPLATE - TAX - TEMPLATE - TICKET - UNKNOWN - UNSUBSCRIBE - USER - VIEW - VIEW_BLOCK - WEB_INTERACTIVE toObjectTypeId: type: string description: The object type ID to which the association points. description: The definition of an association ComboEventRuleBranch: required: - composingRules - operationType - ruleBranches type: object properties: composingRules: type: array description: >- An array of ComboEventRule objects that define the individual rules composing this branch. items: $ref: '#/components/schemas/ComboEventRule' operationType: type: string description: >- The type of logical operation applied to the rule branches and composing rules. Valid values are 'AND' and 'OR'. enum: - AND - OR ruleBranches: type: array description: >- An array of nested ComboEventRuleBranch objects, allowing for hierarchical rule definitions. items: $ref: '#/components/schemas/ComboEventRuleBranch' ExternalObjectResolutionMappingResponse: required: - primaryObjectRule type: object properties: primaryObjectRule: $ref: '#/components/schemas/ExternalPrimaryObjectResolutionRule' BehavioralEventTypeDefinitionLabels: required: - singular type: object properties: plural: type: string description: The plural form of the label for the event type. This is a string. singular: type: string description: >- The singular form of the label for the event type. This is a string and is required. Property: required: - description - fieldType - groupName - label - name - options - type type: object properties: archived: type: boolean description: Indicates whether the property is archived. archivedAt: type: string description: >- The date and time when this property was archived, in ISO 8601 format. format: date-time calculated: type: boolean description: Indicates whether the property is calculated. calculationFormula: type: string description: The formula used to calculate the property's value, if applicable. createdAt: type: string description: >- The date and time when this property was created, in ISO 8601 format. format: date-time createdUserId: type: string description: The ID of the user who created this property. currencyPropertyName: type: string description: The name of the currency property associated with this property. dataSensitivity: type: string description: >- The sensitivity level of the data, with valid values including 'non_sensitive', 'sensitive', and 'highly_sensitive'. enum: - highly_sensitive - non_sensitive - sensitive dateDisplayHint: type: string description: >- A hint for displaying date properties, with valid values including 'absolute', 'absolute_with_relative', 'time_since', and 'time_until'. enum: - absolute - absolute_with_relative - time_since - time_until description: type: string description: A description of the property. displayOrder: type: integer description: >- The order in which this property is displayed relative to other properties. format: int32 externalOptions: type: boolean description: Indicates whether the property options are external. fieldType: type: string description: The field type of the property. formField: type: boolean description: Indicates whether the property is a form field. groupName: type: string description: The name of the group to which this property belongs. hasUniqueValue: type: boolean description: Indicates whether the property has a unique value. hidden: type: boolean description: Indicates whether the property is hidden. example: false hubspotDefined: type: boolean description: Indicates whether the property is defined by HubSpot. label: type: string description: The display label for the property. modificationMetadata: $ref: '#/components/schemas/PropertyModificationMetadata' name: type: string description: The unique name of the property. numberDisplayHint: type: string description: >- A hint for displaying number properties, with valid values including 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'. enum: - currency - duration - formatted - percentage - probability - unformatted options: type: array description: >- An array of options available for this property, applicable if the property supports multiple values. items: $ref: '#/components/schemas/Option' referencedObjectType: type: string description: The type of object that this property references. sensitiveDataCategories: type: array description: An array of categories indicating the sensitivity of the data. items: type: string showCurrencySymbol: type: boolean description: Indicates whether a currency symbol is shown for the property. textDisplayHint: type: string description: >- A hint for displaying text properties, with valid values including 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', and 'postal_code'. enum: - domain_name - email - ip_address - multi_line - phone_number - physical_address - postal_code - unformatted_single_line type: type: string description: The data type of the property. updatedAt: type: string description: >- The date and time when this property was last updated, in ISO 8601 format. format: date-time updatedUserId: type: string description: The ID of the user who last updated this property. description: A HubSpot property Error: required: - category - correlationId - message type: object properties: category: type: string description: The error category. context: type: object additionalProperties: type: array items: type: string description: >- Context about the error condition, represented as an object with additional properties. example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- A unique identifier for the request. Include this value with any error reports or support tickets. format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: >- Further information about the error, represented as an array of ErrorDetail objects. items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- A map of link names to associated URIs containing documentation about the error or recommended remediation steps. message: type: string description: >- A human readable message describing the error along with remediation steps where appropriate. example: An error occurred subCategory: type: string description: >- A specific category that contains more specific detail about the error. description: >- Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered. example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base ComboEventRule: required: - count - eventTypeId - propertyFilters type: object properties: count: type: integer description: >- An integer specifying the number of times the event must occur for the rule to be satisfied. format: int32 eventTypeId: type: string description: The unique identifier for the type of event this rule applies to. lookbackWindowDays: type: integer description: >- An integer representing the number of days to look back when evaluating the rule. format: int32 propertyFilters: type: array description: >- An array of property filters that must be satisfied for the rule to apply. Each filter specifies conditions on event properties. items: $ref: '#/components/schemas/PropertyFilter' ExternalPrimaryObjectResolutionRule: required: - eventPropertyName - targetObjectPropertyName type: object properties: eventPropertyName: type: string description: >- The name of the property on the event that is used for resolution. It is a string. targetObjectPropertyName: type: string description: >- The name of the property on the target object that is used for resolution. It is a string. PropertyModificationMetadata: required: - archivable - readOnlyDefinition - readOnlyValue type: object properties: archivable: type: boolean description: A boolean indicating whether the property can be archived. readOnlyDefinition: type: boolean description: >- A boolean indicating whether the definition of the property is read-only. readOnlyOptions: type: boolean description: >- A boolean indicating whether the options of the property are read-only. readOnlyValue: type: boolean description: A boolean indicating whether the value of the property is read-only. Option: required: - hidden - label - value type: object properties: description: type: string description: A detailed description of the option, providing additional context. displayOrder: type: integer description: >- An integer that determines the order in which the option appears relative to other options. format: int32 hidden: type: boolean description: A boolean indicating whether the option is hidden from users. label: type: string description: The display name of the option, shown to users. value: type: string description: >- The internal value associated with the option, used in data processing. description: A HubSpot property option ErrorDetail: required: - message type: object properties: code: type: string description: >- The status code associated with the error detail. This is a string property. context: type: object additionalProperties: type: array items: type: string description: >- Context about the error condition, represented as an object where each key is a context name and each value is an array of strings providing additional details. example: '{missingScopes=[scope1, scope2]}' in: type: string description: >- The name of the field or parameter in which the error was found. This is a string property. message: type: string description: >- A human readable message describing the error along with remediation steps where appropriate. This is a required string property. subCategory: type: string description: >- A specific category that contains more specific detail about the error. This is a string property. description: >- Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response. PropertyFilter: title: PROPERTY required: - filterType - operation - property type: object properties: context: $ref: '#/components/schemas/PropertyFilterContext' filterInsightsId: type: integer description: An integer representing the ID for insights related to the filter. format: int32 filterType: type: string description: >- A string that specifies the type of filter being applied. The default value is 'PROPERTY'. default: PROPERTY enum: - PROPERTY frameworkFilterId: type: integer description: An integer that uniquely identifies the framework filter. format: int64 operation: description: >- Defines the operation to be performed on the property. It can be one of several types, such as BoolPropertyOperation, NumberPropertyOperation, StringPropertyOperation, etc. oneOf: - $ref: '#/components/schemas/BoolPropertyOperation' - $ref: '#/components/schemas/NumberPropertyOperation' - $ref: '#/components/schemas/StringPropertyOperation' - $ref: '#/components/schemas/DateTimePropertyOperation' - $ref: '#/components/schemas/RangedDatePropertyOperation' - $ref: '#/components/schemas/ComparativeDatePropertyOperation' - $ref: '#/components/schemas/ComparativeBoolPropertyOperation' - $ref: '#/components/schemas/ComparativeNumberPropertyOperation' - $ref: '#/components/schemas/ComparativeStringPropertyOperation' - $ref: '#/components/schemas/ComparativePropertyUpdatedOperation' - $ref: '#/components/schemas/RollingDateRangePropertyOperation' - $ref: '#/components/schemas/RollingPropertyUpdatedOperation' - $ref: '#/components/schemas/EnumerationPropertyOperation' - $ref: '#/components/schemas/AllPropertyTypesOperation' - $ref: '#/components/schemas/RangedNumberPropertyOperation' - $ref: '#/components/schemas/MultiStringPropertyOperation' - $ref: '#/components/schemas/DatePropertyOperation' - $ref: '#/components/schemas/CalendarDatePropertyOperation' - $ref: '#/components/schemas/TimePointOperation' - $ref: '#/components/schemas/RangedTimeOperation' - $ref: '#/components/schemas/RegexPropertyOperation' property: type: string description: >- A string representing the name of the property to which the filter is applied. x-hubspot-sub-type-impl: true PropertyFilterContext: required: - objectTypeId type: object properties: objectTypeId: type: string description: >- A string that uniquely identifies the type of object to which the property filter is applied. BoolPropertyOperation: title: bool required: - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType - value type: object properties: defaultValue: type: string description: A string representing the default value for the operation. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether to include objects that have no value set for the property. operationType: type: string description: A string indicating the type of operation being performed. operator: type: string description: >- A string representing the operation to be performed, with valid values including 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'HAS_EVER_BEEN_EQUAL_TO', and 'HAS_NEVER_BEEN_EQUAL_TO'. enum: - HAS_EVER_BEEN_EQUAL_TO - HAS_NEVER_BEEN_EQUAL_TO - IS_EQUAL_TO - IS_NOT_EQUAL_TO operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string indicating the type of property, with a default value of 'bool'. default: bool enum: - bool renderSpec: type: string description: A string specifying the rendering specification for the operation. value: type: boolean description: A boolean indicating the value to be used in the operation. x-hubspot-sub-type-impl: true NumberPropertyOperation: title: number required: - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType - value type: object properties: defaultValue: type: string description: A string representing the default value for the operation. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether objects with no value set should be included in the operation. operationType: type: string description: A string that specifies the type of operation being performed. operator: type: string description: >- A string representing the operation to be performed on the number property. Valid values include 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'IS_GREATER_THAN', 'IS_GREATER_THAN_OR_EQUAL_TO', 'IS_LESS_THAN', 'IS_LESS_THAN_OR_EQUAL_TO', 'HAS_EVER_BEEN_EQUAL_TO', and 'HAS_NEVER_BEEN_EQUAL_TO'. enum: - HAS_EVER_BEEN_EQUAL_TO - HAS_NEVER_BEEN_EQUAL_TO - IS_EQUAL_TO - IS_GREATER_THAN - IS_GREATER_THAN_OR_EQUAL_TO - IS_LESS_THAN - IS_LESS_THAN_OR_EQUAL_TO - IS_NOT_EQUAL_TO operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string that specifies the type of property operation, with a default value of 'number'. default: number enum: - number renderSpec: type: string description: A string that provides specifications for rendering the operation. value: type: number description: A number that represents the value to be used in the operation. x-hubspot-sub-type-impl: true StringPropertyOperation: title: string required: - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType - value type: object properties: defaultValue: type: string description: >- A string representing the default value to be used if no other value is set. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether objects with no value set should be included in the operation. operationType: type: string description: A string indicating the type of operation being performed. operator: type: string description: >- A string representing the operation to be performed, with valid values including 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'CONTAINS', 'DOES_NOT_CONTAIN', 'STARTS_WITH', 'ENDS_WITH', 'HAS_EVER_BEEN_EQUAL_TO', 'HAS_NEVER_BEEN_EQUAL_TO', 'HAS_EVER_CONTAINED', and 'HAS_NEVER_CONTAINED'. enum: - CONTAINS - DOES_NOT_CONTAIN - ENDS_WITH - HAS_EVER_BEEN_EQUAL_TO - HAS_EVER_CONTAINED - HAS_NEVER_BEEN_EQUAL_TO - HAS_NEVER_CONTAINED - IS_EQUAL_TO - IS_NOT_EQUAL_TO - STARTS_WITH operatorName: type: string description: A string representing the name of the operator. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: A string indicating the type of property, defaulting to 'string'. default: string enum: - string renderSpec: type: string description: A string that provides specifications for rendering the operation. value: type: string description: A string that specifies the value to be used in the operation. x-hubspot-sub-type-impl: true DateTimePropertyOperation: title: datetime required: - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType - requiresTimeZoneConversion - timestamp type: object properties: defaultValue: type: string description: A string representing the default value for the operation. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether to include objects that have no value set for the property. operationType: type: string description: A string indicating the type of operation being performed. operator: type: string description: >- A string representing the operation to be performed, such as 'IS_BEFORE', 'IS_AFTER', 'IS_EQUAL_TO', 'IS_BEFORE_DATE', or 'IS_AFTER_DATE'. enum: - IS_AFTER - IS_AFTER_DATE - IS_BEFORE - IS_BEFORE_DATE - IS_EQUAL_TO operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string indicating the type of property, with a default value of 'datetime'. default: datetime enum: - datetime renderSpec: type: string description: A string specifying the rendering specification for the operation. requiresTimeZoneConversion: type: boolean description: >- A boolean indicating whether the operation requires time zone conversion. timestamp: type: integer description: >- An integer representing the timestamp for the operation, in int64 format. format: int64 x-hubspot-sub-type-impl: true RangedDatePropertyOperation: title: datetime-ranged required: - includeObjectsWithNoValueSet - lowerBoundTimestamp - operationType - operator - operatorName - propertyType - requiresTimeZoneConversion - upperBoundTimestamp type: object properties: defaultValue: type: string description: A string representing the default value for the operation. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether to include objects that have no value set for the property. lowerBoundTimestamp: type: integer description: >- An integer representing the lower bound of the date range as a Unix timestamp in milliseconds. format: int64 operationType: type: string description: A string representing the type of operation being performed. operator: type: string description: >- A string representing the operation to be performed, with valid values including 'IS_BETWEEN' and 'IS_NOT_BETWEEN'. enum: - IS_BETWEEN - IS_NOT_BETWEEN operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string indicating the type of property, defaulting to 'datetime-ranged'. default: datetime-ranged enum: - datetime-ranged renderSpec: type: string description: A string specifying the rendering specification for the operation. requiresTimeZoneConversion: type: boolean description: >- A boolean indicating whether time zone conversion is required for this operation. upperBoundTimestamp: type: integer description: >- An integer representing the upper bound of the date range as a Unix timestamp in milliseconds. format: int64 x-hubspot-sub-type-impl: true ComparativeDatePropertyOperation: title: datetime-comparative required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType type: object properties: comparisonPropertyName: type: string description: A string specifying the name of the property to be compared against. defaultComparisonValue: type: string description: >- A string representing the default value to compare against if the comparison property is not set. defaultValue: type: string description: >- A string representing the default value to use if no specific comparison value is set. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether to include objects that do not have a value set for the property being compared. operationType: type: string description: A string indicating the type of operation being performed. operator: type: string description: >- A string representing the comparison operator used in the operation. Valid values include 'IS_BEFORE' and 'IS_AFTER'. enum: - IS_AFTER - IS_BEFORE operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string indicating the type of property operation, which is 'datetime-comparative' for this component. default: datetime-comparative enum: - datetime-comparative renderSpec: type: string description: A string providing specifications for rendering the operation. x-hubspot-sub-type-impl: true ComparativeBoolPropertyOperation: title: bool-comparative required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType type: object properties: comparisonPropertyName: type: string description: A string specifying the name of the property to compare against. defaultValue: type: string description: A string representing the default value to use if no value is set. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether objects with no value set for the property should be included in the operation. operationType: type: string description: A string specifying the type of operation being performed. operator: type: string description: >- A string representing the comparison operator to be used. Valid values are 'IS_EQUAL_TO' and 'IS_NOT_EQUAL_TO'. enum: - IS_EQUAL_TO - IS_NOT_EQUAL_TO operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string indicating the type of property operation, defaulting to 'bool-comparative'. default: bool-comparative enum: - bool-comparative renderSpec: type: string description: >- A string that may define how the operation should be rendered, though specifics are not detailed in the spec. x-hubspot-sub-type-impl: true ComparativeNumberPropertyOperation: title: number-comparative required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType type: object properties: comparisonPropertyName: type: string description: A string representing the name of the property to compare against. defaultValue: type: string description: >- A string representing the default value to use if no comparison value is set. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether to include objects that have no value set for the property being compared. operationType: type: string description: A string representing the type of operation being performed. operator: type: string description: >- A string representing the comparison operator. Valid values include 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'IS_GREATER_THAN', 'IS_GREATER_THAN_OR_EQUAL_TO', 'IS_LESS_THAN', and 'IS_LESS_THAN_OR_EQUAL_TO'. enum: - IS_EQUAL_TO - IS_GREATER_THAN - IS_GREATER_THAN_OR_EQUAL_TO - IS_LESS_THAN - IS_LESS_THAN_OR_EQUAL_TO - IS_NOT_EQUAL_TO operatorName: type: string description: A string representing the name of the operator. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string indicating the type of property operation. Defaults to 'number-comparative'. default: number-comparative enum: - number-comparative renderSpec: type: string description: A string that specifies how the operation should be rendered. x-hubspot-sub-type-impl: true ComparativeStringPropertyOperation: title: string-comparative required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType type: object properties: comparisonPropertyName: type: string description: >- The name of the property to compare against, represented as a string. defaultValue: type: string description: >- A string representing the default value to use in the operation if no value is set. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether to include objects that do not have a value set for the property. operationType: type: string description: A string representing the type of operation being performed. operator: type: string description: >- A string representing the comparison operation to perform. Valid values include 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'CONTAINS', 'DOES_NOT_CONTAIN', 'STARTS_WITH', and 'ENDS_WITH'. enum: - CONTAINS - DOES_NOT_CONTAIN - ENDS_WITH - IS_EQUAL_TO - IS_NOT_EQUAL_TO - STARTS_WITH operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string indicating the type of property operation, defaulting to 'string-comparative'. default: string-comparative enum: - string-comparative renderSpec: type: string description: A string specifying how the operation should be rendered. x-hubspot-sub-type-impl: true ComparativePropertyUpdatedOperation: title: property-updated-comparative required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType type: object properties: comparisonPropertyName: type: string description: A string representing the name of the property to compare against. defaultComparisonValue: type: string description: >- A string that specifies the default comparison value to use if no comparison value is set. defaultValue: type: string description: A string that specifies the default value to use if no value is set. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether to include objects that have no value set for the property. operationType: type: string description: A string representing the type of operation being performed. operator: type: string description: >- A string that defines the comparison operator to use, with valid values being 'IS_BEFORE' and 'IS_AFTER'. enum: - IS_AFTER - IS_BEFORE operatorName: type: string description: A string that provides a human-readable name for the operator. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string that specifies the type of property operation, with a default value of 'property-updated-comparative'. default: property-updated-comparative enum: - property-updated-comparative renderSpec: type: string description: A string that defines the rendering specification for the operation. x-hubspot-sub-type-impl: true RollingDateRangePropertyOperation: title: datetime-rolling required: - includeObjectsWithNoValueSet - numberOfDays - operationType - operator - operatorName - propertyType - requiresTimeZoneConversion type: object properties: defaultValue: type: string description: A string representing the default value for the operation. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether to include objects that have no value set for the property. numberOfDays: type: integer description: >- An integer specifying the number of days for the rolling date range operation. format: int32 operationType: type: string description: A string indicating the type of operation being performed. operator: type: string description: >- A string specifying the operation to perform, with valid values including 'IS_LESS_THAN_X_DAYS_AGO', 'IS_MORE_THAN_X_DAYS_AGO', 'IS_LESS_THAN_X_DAYS_FROM_NOW', and 'IS_MORE_THAN_X_DAYS_FROM_NOW'. enum: - IS_LESS_THAN_X_DAYS_AGO - IS_LESS_THAN_X_DAYS_FROM_NOW - IS_MORE_THAN_X_DAYS_AGO - IS_MORE_THAN_X_DAYS_FROM_NOW operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string indicating the type of property, with a default value of 'datetime-rolling'. default: datetime-rolling enum: - datetime-rolling renderSpec: type: string description: >- A string that specifies the rendering specification for the operation. requiresTimeZoneConversion: type: boolean description: >- A boolean indicating whether the operation requires time zone conversion. x-hubspot-sub-type-impl: true RollingPropertyUpdatedOperation: title: rolling-property-updated required: - includeObjectsWithNoValueSet - numberOfDays - operationType - operator - operatorName - propertyType type: object properties: defaultValue: type: string description: A string that provides a default value for the operation. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether objects with no value set should be included in the operation. numberOfDays: type: integer description: >- An integer representing the number of days to consider for the operation. format: int32 operationType: type: string description: A string that specifies the type of operation being performed. operator: type: string description: >- A string specifying the operation to be performed, with valid values being 'UPDATED_IN_LAST_X_DAYS' and 'NOT_UPDATED_IN_LAST_X_DAYS'. enum: - NOT_UPDATED_IN_LAST_X_DAYS - UPDATED_IN_LAST_X_DAYS operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string indicating the type of property operation, which is 'rolling-property-updated'. default: rolling-property-updated enum: - rolling-property-updated renderSpec: type: string description: >- A string that specifies the rendering specification for the operation. x-hubspot-sub-type-impl: true EnumerationPropertyOperation: title: enumeration required: - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType - values type: object properties: defaultValue: type: string description: A string representing the default value for the operation. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether to include objects that have no value set for the property. operationType: type: string description: A string indicating the type of operation being performed. operator: type: string description: >- A string specifying the operation to perform, with valid values including 'IS_ANY_OF', 'IS_NONE_OF', 'IS_EXACTLY', 'IS_NOT_EXACTLY', 'CONTAINS_ALL', 'DOES_NOT_CONTAIN_ALL', 'HAS_EVER_BEEN_ANY_OF', 'HAS_NEVER_BEEN_ANY_OF', 'HAS_EVER_BEEN_EXACTLY', 'HAS_NEVER_BEEN_EXACTLY', 'HAS_EVER_CONTAINED_ALL', and 'HAS_NEVER_CONTAINED_ALL'. enum: - CONTAINS_ALL - DOES_NOT_CONTAIN_ALL - HAS_EVER_BEEN_ANY_OF - HAS_EVER_BEEN_EXACTLY - HAS_EVER_CONTAINED_ALL - HAS_NEVER_BEEN_ANY_OF - HAS_NEVER_BEEN_EXACTLY - HAS_NEVER_CONTAINED_ALL - IS_ANY_OF - IS_EXACTLY - IS_NONE_OF - IS_NOT_EXACTLY operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string indicating the type of property, which is 'enumeration' for this operation. default: enumeration enum: - enumeration renderSpec: type: string description: >- A string that specifies the rendering specifications for the operation. values: type: array description: >- An array of strings representing the values to be used in the operation. items: type: string x-hubspot-sub-type-impl: true AllPropertyTypesOperation: title: alltypes required: - coalescingRefineBy - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType type: object properties: coalescingRefineBy: description: >- An object used to refine the operation by coalescing, which can be one of several types such as NumOccurrencesRefineBy or SetOccurrencesRefineBy. oneOf: - $ref: '#/components/schemas/NumOccurrencesRefineBy' - $ref: '#/components/schemas/SetOccurrencesRefineBy' defaultValue: type: string description: A string specifying the default value for the operation. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether objects with no value set should be included in the operation. operationType: type: string description: A string indicating the type of operation being performed. operator: type: string description: >- A string representing the operation to be performed, with valid values including 'IS_KNOWN', 'IS_UNKNOWN', 'IS_BLANK', and 'IS_NOT_BLANK'. enum: - IS_BLANK - IS_KNOWN - IS_NOT_BLANK - IS_UNKNOWN operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string indicating the type of property, with a default value of 'alltypes'. default: alltypes enum: - alltypes pruningRefineBy: description: >- An object used to refine the operation by pruning, which can be one of several types such as RelativeComparativeTimestampRefineBy or AbsoluteRangedTimestampRefineBy. oneOf: - $ref: '#/components/schemas/RelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/RelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/AbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/AbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/AllHistoryRefineBy' - $ref: '#/components/schemas/TimePointOperation' - $ref: '#/components/schemas/RangedTimeOperation' renderSpec: type: string description: A string providing specifications for rendering the operation. x-hubspot-sub-type-impl: true RangedNumberPropertyOperation: title: number-ranged required: - includeObjectsWithNoValueSet - lowerBound - operationType - operator - operatorName - propertyType - upperBound type: object properties: defaultValue: type: string description: A string representing the default value for the operation. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether objects with no value set should be included in the operation. lowerBound: type: number description: A number that specifies the lower bound of the range. operationType: type: string description: A string that describes the type of operation being performed. operator: type: string description: >- A string that defines the operation to be performed, with valid values including 'IS_BETWEEN' and 'IS_NOT_BETWEEN'. enum: - IS_BETWEEN - IS_NOT_BETWEEN operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string that specifies the type of property operation, with a default value of 'number-ranged'. default: number-ranged enum: - number-ranged renderSpec: type: string description: A string that provides specifications for rendering the operation. upperBound: type: number description: A number that specifies the upper bound of the range. x-hubspot-sub-type-impl: true MultiStringPropertyOperation: title: multistring required: - coalescingRefineBy - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType - values type: object properties: coalescingRefineBy: description: >- A refinement option for coalescing operations, which can be either 'NumOccurrencesRefineBy' or 'SetOccurrencesRefineBy'. oneOf: - $ref: '#/components/schemas/NumOccurrencesRefineBy' - $ref: '#/components/schemas/SetOccurrencesRefineBy' defaultValue: type: string description: A default value to be used if no other value is set. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether objects with no value set should be included in the operation. operationType: type: string description: The type of operation being performed. operator: type: string description: >- The operator used in the operation. Valid values include 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'CONTAINS', 'CONTAINS_EXACTLY', 'DOES_NOT_CONTAIN', 'DOES_NOT_CONTAIN_EXACTLY', 'STARTS_WITH', and 'ENDS_WITH'. enum: - CONTAINS - CONTAINS_EXACTLY - DOES_NOT_CONTAIN - DOES_NOT_CONTAIN_EXACTLY - ENDS_WITH - IS_EQUAL_TO - IS_NOT_EQUAL_TO - STARTS_WITH operatorName: type: string description: The name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- The type of property being operated on, which is 'multistring' for this operation. default: multistring enum: - multistring pruningRefineBy: description: >- A refinement option that further specifies the operation, which can be one of several types such as 'RelativeComparativeTimestampRefineBy', 'RelativeRangedTimestampRefineBy', 'AbsoluteComparativeTimestampRefineBy', 'AbsoluteRangedTimestampRefineBy', 'AllHistoryRefineBy', 'TimePointOperation', or 'RangedTimeOperation'. oneOf: - $ref: '#/components/schemas/RelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/RelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/AbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/AbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/AllHistoryRefineBy' - $ref: '#/components/schemas/TimePointOperation' - $ref: '#/components/schemas/RangedTimeOperation' renderSpec: type: string description: A specification for how the operation should be rendered. values: type: array description: An array of string values that are involved in the operation. items: type: string x-hubspot-sub-type-impl: true DatePropertyOperation: title: date required: - day - includeObjectsWithNoValueSet - month - operationType - operator - operatorName - propertyType - year type: object properties: day: type: integer description: An integer specifying the day component of the date. format: int32 defaultValue: type: string description: >- A string representing the default value to use if no specific value is set. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether to include objects that have no value set for the property. month: type: string description: An integer specifying the month component of the date. enum: - APR - AUG - DEC - FEB - JAN - JUL - JUN - MAR - MAY - NOV - OCT - SEP operationType: type: string description: A string indicating the type of operation being performed. operator: type: string description: >- A string representing the operation to be performed, with valid values including 'IS_BEFORE', 'IS_AFTER', and 'IS_EQUAL_TO'. enum: - AFTER - BEFORE - EQUAL operatorName: type: string description: A string that provides a human-readable name for the operator. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: A string indicating the type of property, which defaults to 'date'. default: date enum: - date renderSpec: type: string description: >- A string that specifies how the operation should be rendered or displayed. year: type: integer description: An integer specifying the year component of the date. format: int32 x-hubspot-sub-type-impl: true CalendarDatePropertyOperation: title: calendar-date required: - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType - timeUnit - timeUnitCount - useFiscalYear type: object properties: defaultValue: type: string description: A string representing the default value for the operation. fiscalYearStart: type: string description: >- A string that defines the starting month of the fiscal year, with options such as 'JANUARY', 'FEBRUARY', 'MARCH', etc. enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER includeObjectsWithNoValueSet: type: boolean description: >- A boolean that determines whether objects with no value set should be included in the operation. operationType: type: string description: A string that specifies the type of operation being performed. operator: type: string description: >- A string that indicates the operation to be performed, with possible values including 'IN_THIS_TIME_UNIT', 'IN_THIS_TIME_UNIT_SO_FAR', 'IN_NEXT_TIME_UNIT', 'IN_LAST_TIME_UNIT', and 'IN_LAST_TIME_UNIT_SO_FAR'. enum: - IN_LAST_TIME_UNIT - IN_LAST_TIME_UNIT_SO_FAR - IN_NEXT_TIME_UNIT - IN_THIS_TIME_UNIT - IN_THIS_TIME_UNIT_SO_FAR operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string that specifies the type of property operation, defaulting to 'calendar-date'. default: calendar-date enum: - calendar-date renderSpec: type: string description: A string specifying the rendering specification for the operation. timeUnit: type: string description: >- A string representing the unit of time for the operation, which can be 'DAY', 'WEEK', 'MONTH', 'QUARTER', or 'YEAR'. enum: - DAY - MONTH - QUARTER - WEEK - YEAR timeUnitCount: type: integer description: >- An integer specifying the number of time units to consider in the operation. format: int32 useFiscalYear: type: boolean description: >- A boolean indicating whether the fiscal year should be used in the operation. x-hubspot-sub-type-impl: true TimePointOperation: title: timepoint required: - endpointBehavior - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyParser - propertyType - timePoint - type type: object properties: defaultValue: type: string description: A string indicating the default value used in the operation. endpointBehavior: type: string description: >- A string indicating the endpoint behavior, with possible values 'INCLUSIVE' and 'EXCLUSIVE'. enum: - EXCLUSIVE - INCLUSIVE includeObjectsWithNoValueSet: type: boolean description: A boolean indicating whether to include objects with no value set. operationType: type: string description: A string indicating the type of operation. operator: type: string description: >- A string specifying the operator used in the operation, with possible values 'IS_BEFORE' and 'IS_AFTER'. enum: - IS_AFTER - IS_BEFORE operatorName: type: string description: A string representing the name of the operator. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyParser: type: string description: >- A string specifying the property parser, with possible values 'VALUE', 'UPDATED_AT', 'ANNIVERSARY', 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION', and 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION'. enum: - ANNIVERSARY - ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION - UPDATED_AT - VALUE - VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION propertyType: type: string description: A string indicating the type of property, defaulting to 'timepoint'. default: timepoint enum: - timepoint renderSpec: type: string description: A string representing the rendering specification. timePoint: description: >- A reference to a time point, which can be a DatePoint, IndexedTimePoint, or PropertyReferencedTime. oneOf: - $ref: '#/components/schemas/DatePoint' - $ref: '#/components/schemas/IndexedTimePoint' - $ref: '#/components/schemas/PropertyReferencedTime' type: type: string description: A string representing the type of the operation. x-hubspot-sub-type-impl: true RangedTimeOperation: title: rangedtime required: - includeObjectsWithNoValueSet - lowerBoundEndpointBehavior - lowerBoundTimePoint - operationType - operator - operatorName - propertyParser - propertyType - type - upperBoundEndpointBehavior - upperBoundTimePoint type: object properties: defaultValue: type: string description: A string representing the default value for the operation. includeObjectsWithNoValueSet: type: boolean description: >- A boolean indicating whether to include objects that have no value set. lowerBoundEndpointBehavior: type: string description: >- A string indicating the behavior of the lower bound endpoint, with valid values 'INCLUSIVE' and 'EXCLUSIVE'. enum: - EXCLUSIVE - INCLUSIVE lowerBoundTimePoint: description: >- The lower bound time point for the operation, which can be a DatePoint, IndexedTimePoint, or PropertyReferencedTime. oneOf: - $ref: '#/components/schemas/DatePoint' - $ref: '#/components/schemas/IndexedTimePoint' - $ref: '#/components/schemas/PropertyReferencedTime' operationType: type: string description: A string indicating the type of operation being performed. operator: type: string description: >- A string representing the operator used in the operation. Valid values include 'IS_BETWEEN' and 'IS_NOT_BETWEEN'. enum: - IS_BETWEEN - IS_NOT_BETWEEN operatorName: type: string description: >- A string representing the name of the operator used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyParser: type: string description: >- A string that specifies the parser for the property. Valid values include 'VALUE', 'UPDATED_AT', 'ANNIVERSARY', 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION', and 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION'. enum: - ANNIVERSARY - ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION - UPDATED_AT - VALUE - VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION propertyType: type: string description: >- A string that specifies the type of property, with a default value of 'rangedtime'. default: rangedtime enum: - rangedtime renderSpec: type: string description: A string that provides specifications for rendering. type: type: string description: A string indicating the type of the operation. upperBoundEndpointBehavior: type: string description: >- A string indicating the behavior of the upper bound endpoint, with valid values 'INCLUSIVE' and 'EXCLUSIVE'. enum: - EXCLUSIVE - INCLUSIVE upperBoundTimePoint: description: >- The upper bound time point for the operation, which can be a DatePoint, IndexedTimePoint, or PropertyReferencedTime. oneOf: - $ref: '#/components/schemas/DatePoint' - $ref: '#/components/schemas/IndexedTimePoint' - $ref: '#/components/schemas/PropertyReferencedTime' x-hubspot-sub-type-impl: true RegexPropertyOperation: title: regex required: - caseSensitive - includeObjectsWithNoValueSet - operationType - operator - operatorName - pattern - propertyType type: object properties: caseSensitive: type: boolean description: >- A boolean indicating whether the regex matching should be case-sensitive. defaultValue: type: string description: A string specifying the default value to be used if no value is set. includeObjectsWithNoValueSet: type: boolean description: >- A boolean that determines whether objects with no value set should be included in the operation. operationType: type: string description: A string indicating the type of operation being performed. operator: type: string description: >- A string specifying the operation to perform, with valid values being 'MATCHES_REGEX' and 'DOES_NOT_MATCH_REGEX'. enum: - DOES_NOT_MATCH_REGEX - MATCHES_REGEX operatorName: type: string description: >- A string representing the name of the operator used in the operation. pattern: type: string description: A string representing the regex pattern to be used in the operation. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- A string indicating the type of property operation, which is 'regex' for this component. default: regex enum: - regex renderSpec: type: string description: >- A string that may define how the operation is rendered, though its specific use is not detailed. x-hubspot-sub-type-impl: true PropertyAspect: required: - aspect type: object properties: aspect: type: string enum: - TIMERANGE_END - TIMERANGE_START qualifier: type: string NumOccurrencesRefineBy: title: NumOccurrencesRefineBy required: - type type: object properties: maxOccurrences: type: integer description: >- An integer indicating the maximum number of times an event can occur. format: int32 minOccurrences: type: integer description: >- An integer indicating the minimum number of times an event must occur. format: int32 type: type: string description: >- A string that specifies the type of refinement, which is 'NumOccurrencesRefineBy'. default: NumOccurrencesRefineBy enum: - NumOccurrencesRefineBy x-hubspot-sub-type-impl: true SetOccurrencesRefineBy: title: SetOccurrencesRefineBy required: - setType - type type: object properties: setType: type: string description: >- A string that indicates the set type for the refinement operation. Valid values include 'ALL', 'ALL_INCLUDE_EMPTY', 'ANY', 'NONE', 'NONE_EXCLUDE_EMPTY', and 'ANY_INCLUDE_EMPTY'. enum: - ALL - ALL_INCLUDE_EMPTY - ANY - ANY_INCLUDE_EMPTY - NONE - NONE_EXCLUDE_EMPTY type: type: string description: >- A string that specifies the type of refinement operation. The default value is 'SetOccurrencesRefineBy'. default: SetOccurrencesRefineBy enum: - SetOccurrencesRefineBy x-hubspot-sub-type-impl: true RelativeComparativeTimestampRefineBy: title: RelativeComparativeTimestampRefineBy required: - comparison - timeOffset - type type: object properties: comparison: type: string description: >- A string indicating the type of comparison to be made, with valid values being 'BEFORE' or 'AFTER'. enum: - AFTER - BEFORE timeOffset: $ref: '#/components/schemas/TimeOffset' type: type: string description: >- A string indicating the type of refinement operation, which is 'RelativeComparativeTimestampRefineBy'. default: RelativeComparativeTimestampRefineBy enum: - RelativeComparativeTimestampRefineBy x-hubspot-sub-type-impl: true RelativeRangedTimestampRefineBy: title: RelativeRangedTimestampRefineBy required: - lowerBoundOffset - rangeType - type - upperBoundOffset type: object properties: lowerBoundOffset: $ref: '#/components/schemas/TimeOffset' rangeType: type: string description: >- A string indicating the type of range operation, with valid values 'BETWEEN' and 'NOT_BETWEEN'. enum: - BETWEEN - NOT_BETWEEN type: type: string description: >- A string indicating the type of refinement, with a default value of 'RelativeRangedTimestampRefineBy'. default: RelativeRangedTimestampRefineBy enum: - RelativeRangedTimestampRefineBy upperBoundOffset: $ref: '#/components/schemas/TimeOffset' x-hubspot-sub-type-impl: true AbsoluteComparativeTimestampRefineBy: title: AbsoluteComparativeTimestampRefineBy required: - comparison - timestamp - type type: object properties: comparison: type: string description: >- A string indicating the type of comparison to be made with the timestamp. Valid values are 'BEFORE' and 'AFTER'. enum: - AFTER - BEFORE timestamp: type: integer description: >- An integer representing the specific timestamp to be used in the comparison, formatted as an int64. format: int64 type: type: string description: >- A string that specifies the type of refinement, with a default value of 'AbsoluteComparativeTimestampRefineBy'. default: AbsoluteComparativeTimestampRefineBy enum: - AbsoluteComparativeTimestampRefineBy x-hubspot-sub-type-impl: true AbsoluteRangedTimestampRefineBy: title: AbsoluteRangedTimestampRefineBy required: - lowerTimestamp - rangeType - type - upperTimestamp type: object properties: lowerTimestamp: type: integer description: >- An integer representing the lower bound of the timestamp range, in milliseconds since the Unix epoch. format: int64 rangeType: type: string description: >- A string that indicates the type of range comparison. Valid values are 'BETWEEN' and 'NOT_BETWEEN'. enum: - BETWEEN - NOT_BETWEEN type: type: string description: >- A string that specifies the type of the component, which is 'AbsoluteRangedTimestampRefineBy'. default: AbsoluteRangedTimestampRefineBy enum: - AbsoluteRangedTimestampRefineBy upperTimestamp: type: integer description: >- An integer representing the upper bound of the timestamp range, in milliseconds since the Unix epoch. format: int64 x-hubspot-sub-type-impl: true AllHistoryRefineBy: title: AllHistoryRefineBy required: - type type: object properties: type: type: string description: >- A string that specifies the type of refinement. The default value is 'AllHistoryRefineBy', and it is the only valid value for this property. default: AllHistoryRefineBy enum: - AllHistoryRefineBy x-hubspot-sub-type-impl: true DatePoint: title: DATE required: - day - month - timeType - timezoneSource - year - zoneId type: object properties: day: type: integer description: An integer representing the day component of the date. format: int32 hour: type: integer description: An integer representing the hour component of the time. format: int32 millisecond: type: integer description: An integer representing the millisecond component of the time. format: int32 minute: type: integer description: An integer representing the minute component of the time. format: int32 month: type: integer description: An integer representing the month component of the date. format: int32 second: type: integer description: An integer representing the second component of the time. format: int32 timeType: type: string description: >- A string indicating the type of time representation, with a default value of 'DATE'. default: DATE enum: - DATE timezoneSource: type: string description: >- A string specifying the source of the timezone information. Valid values include 'CUSTOM', 'USER', and 'PORTAL'. enum: - CUSTOM - PORTAL - USER year: type: integer description: An integer representing the year component of the date. format: int32 zoneId: type: string description: A string representing the identifier for the timezone. x-hubspot-sub-type-impl: true IndexedTimePoint: title: INDEXED required: - indexReference - timeType - timezoneSource - zoneId type: object properties: indexReference: description: >- An object that serves as the reference point for the indexed time, which can be one of several types such as NowReference, TodayReference, WeekReference, MonthReference, QuarterReference, FiscalQuarter, YearReference, or FiscalYear. oneOf: - $ref: '#/components/schemas/NowReference' - $ref: '#/components/schemas/TodayReference' - $ref: '#/components/schemas/WeekReference' - $ref: '#/components/schemas/MonthReference' - $ref: '#/components/schemas/QuarterReference' - $ref: '#/components/schemas/FiscalQuarter' - $ref: '#/components/schemas/YearReference' - $ref: '#/components/schemas/FiscalYear' offset: $ref: '#/components/schemas/IndexOffset' shouldGenerateRefreshTime: type: boolean description: A boolean indicating whether a refresh time should be generated. timeType: type: string description: A string indicating the type of time point, defaulting to 'INDEXED'. default: INDEXED enum: - INDEXED timezoneSource: type: string description: >- A string specifying the source of the timezone, with possible values including 'CUSTOM', 'USER', and 'PORTAL'. enum: - CUSTOM - PORTAL - USER zoneId: type: string description: A string representing the identifier of the timezone. x-hubspot-sub-type-impl: true PropertyReferencedTime: title: PROPERTY_REFERENCED required: - property - referenceType - timeType - timezoneSource - zoneId type: object properties: property: type: string description: >- A string that indicates the property name used for referencing the time. referenceType: type: string description: >- A string that defines the type of reference, with valid values including 'VALUE', 'UPDATED_AT', 'ANNIVERSARY', 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION', and 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION'. enum: - ANNIVERSARY - ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION - UPDATED_AT - VALUE - VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION timeType: type: string description: >- A string indicating the type of time reference, with a default value of 'PROPERTY_REFERENCED'. default: PROPERTY_REFERENCED enum: - PROPERTY_REFERENCED timezoneSource: type: string description: >- A string specifying the source of the timezone, which can be 'CUSTOM', 'USER', or 'PORTAL'. enum: - CUSTOM - PORTAL - USER zoneId: type: string description: A string representing the identifier of the timezone. x-hubspot-sub-type-impl: true TimeOffset: required: - amount - offsetDirection - timeUnit type: object properties: amount: type: integer description: >- An integer specifying the amount of time to offset, measured in the unit defined by the timeUnit property. format: int64 offsetDirection: type: string description: >- A string indicating the direction of the time offset. Valid values are 'PAST' and 'FUTURE'. enum: - FUTURE - PAST timeUnit: type: string description: >- A string representing the unit of time for the offset. Valid values include 'WEEKS', 'DAYS', 'HOURS', and 'MINUTES'. enum: - DAYS - HOURS - MINUTES - WEEKS NowReference: title: NOW required: - referenceType type: object properties: hour: type: integer description: An integer representing the hour of the current time. format: int32 millisecond: type: integer description: An integer representing the millisecond of the current time. format: int32 minute: type: integer description: An integer representing the minute of the current time. format: int32 referenceType: type: string description: >- A string indicating the type of reference, which is always 'NOW' for this component. default: NOW enum: - NOW second: type: integer description: An integer representing the second of the current time. format: int32 x-hubspot-sub-type-impl: true TodayReference: title: TODAY required: - referenceType type: object properties: hour: type: integer description: An integer representing the hour of the day. format: int32 millisecond: type: integer description: An integer representing the millisecond within the second. format: int32 minute: type: integer description: An integer representing the minute within the hour. format: int32 referenceType: type: string description: A string indicating the type of reference, which is always 'TODAY'. default: TODAY enum: - TODAY second: type: integer description: An integer representing the second within the minute. format: int32 x-hubspot-sub-type-impl: true WeekReference: title: WEEK required: - dayOfWeek - referenceType type: object properties: dayOfWeek: type: string description: >- A string representing the day of the week. Valid values include 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', and 'SUNDAY'. enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY hour: type: integer description: An integer representing the hour of the day. format: int32 millisecond: type: integer description: An integer representing the millisecond within the second. format: int32 minute: type: integer description: An integer representing the minute within the hour. format: int32 referenceType: type: string description: >- A string indicating the type of reference, which is 'WEEK' by default. default: WEEK enum: - WEEK second: type: integer description: An integer representing the second within the minute. format: int32 x-hubspot-sub-type-impl: true MonthReference: title: MONTH required: - day - referenceType type: object properties: day: type: integer description: An integer representing the day of the month. format: int32 hour: type: integer description: An integer representing the hour of the day. format: int32 millisecond: type: integer description: An integer representing the millisecond within the second. format: int32 minute: type: integer description: An integer representing the minute within the hour. format: int32 referenceType: type: string description: >- A string that specifies the type of reference, which is 'MONTH' for this component. default: MONTH enum: - MONTH second: type: integer description: An integer representing the second within the minute. format: int32 x-hubspot-sub-type-impl: true QuarterReference: title: QUARTER required: - day - month - referenceType type: object properties: day: type: integer description: An integer representing the day of the month. format: int32 hour: type: integer description: An integer representing the hour of the day. format: int32 millisecond: type: integer description: An integer representing the millisecond of the second. format: int32 minute: type: integer description: An integer representing the minute of the hour. format: int32 month: type: integer description: An integer representing the month of the quarter. format: int32 referenceType: type: string description: >- A string that specifies the type of reference. The default value is 'QUARTER'. default: QUARTER enum: - QUARTER second: type: integer description: An integer representing the second of the minute. format: int32 x-hubspot-sub-type-impl: true FiscalQuarter: title: FISCAL_QUARTER required: - day - month - referenceType type: object properties: day: type: integer description: An integer representing the day of the fiscal quarter. format: int32 hour: type: integer description: An integer representing the hour of the day. format: int32 millisecond: type: integer description: An integer representing the millisecond within the second. format: int32 minute: type: integer description: An integer representing the minute within the hour. format: int32 month: type: integer description: An integer representing the month of the fiscal quarter. format: int32 referenceType: type: string description: >- A string that indicates the type of reference, which is 'FISCAL_QUARTER' for this component. default: FISCAL_QUARTER enum: - FISCAL_QUARTER second: type: integer description: An integer representing the second within the minute. format: int32 x-hubspot-sub-type-impl: true YearReference: title: YEAR required: - day - month - referenceType type: object properties: day: type: integer description: An integer representing the day of the month. format: int32 hour: type: integer description: An integer representing the hour of the day. format: int32 millisecond: type: integer description: An integer representing the millisecond within the second. format: int32 minute: type: integer description: An integer representing the minute within the hour. format: int32 month: type: integer description: An integer representing the month of the year. format: int32 referenceType: type: string description: >- A string indicating the type of reference, which is 'YEAR' by default. default: YEAR enum: - YEAR second: type: integer description: An integer representing the second within the minute. format: int32 x-hubspot-sub-type-impl: true FiscalYear: title: FISCAL_YEAR required: - day - month - referenceType type: object properties: day: type: integer description: An integer representing the day of the fiscal year. format: int32 hour: type: integer description: An integer representing the hour component of the time. format: int32 millisecond: type: integer description: An integer representing the millisecond component of the time. format: int32 minute: type: integer description: An integer representing the minute component of the time. format: int32 month: type: integer description: An integer representing the month of the fiscal year. format: int32 referenceType: type: string description: >- A string indicating the type of reference, defaulting to 'FISCAL_YEAR'. default: FISCAL_YEAR enum: - FISCAL_YEAR second: type: integer description: An integer representing the second component of the time. format: int32 x-hubspot-sub-type-impl: true IndexOffset: type: object properties: days: type: integer description: An integer representing the number of days for the time offset. format: int32 hours: type: integer description: An integer representing the number of hours for the time offset. format: int32 milliseconds: type: integer description: >- An integer representing the number of milliseconds for the time offset. format: int32 minutes: type: integer description: An integer representing the number of minutes for the time offset. format: int32 months: type: integer description: An integer representing the number of months for the time offset. format: int32 quarters: type: integer description: An integer representing the number of quarters for the time offset. format: int32 seconds: type: integer description: An integer representing the number of seconds for the time offset. format: int32 weeks: type: integer description: An integer representing the number of weeks for the time offset. format: int32 years: type: integer description: An integer representing the number of years for the time offset. format: int32 responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://app.hubspot.com/oauth/authorize tokenUrl: https://api.hubapi.com/oauth/v1/token scopes: analytics.behavioral_events.send: '' behavioral_events.event_definitions.read_write: '' ````