--- title: "Retrieve revision" method: GET path: "/automation/2026-09-beta/flows/{flowId}/revisions/{revisionId}" tags: ["Advanced"] --- # Retrieve revision `GET /automation/2026-09-beta/flows/{flowId}/revisions/{revisionId}` ## Request - Base URL: `https://api.hubapi.com` - URL: `https://api.hubapi.com/automation/2026-09-beta/flows/{flowId}/revisions/{revisionId}` - Auth: one of: - OAuth 2 - Authorization code: `https://app.hubspot.com/oauth/authorize` - Token URL: `https://api.hubapi.com/oauth/v1/token` scopes: `automation` - OAuth 2 - Authorization code: `https://app.hubspot.com/oauth/authorize` - Token URL: `https://api.hubapi.com/oauth/v1/token` scopes: `workflows.write` - OAuth 2 - Authorization code: `https://app.hubspot.com/oauth/authorize` - Token URL: `https://api.hubapi.com/oauth/v1/token` scopes: `workflows.delete` - OAuth 2 - Authorization code: `https://app.hubspot.com/oauth/authorize` - Token URL: `https://api.hubapi.com/oauth/v1/token` scopes: `workflows.read` Retrieve a specific revision of an automation flow using its flow ID and revision ID. This endpoint is useful for accessing historical versions of a flow to review changes or restore previous configurations. ## Path parameters - `flowId` string, required - `revisionId` string, required ## Response `200` successful operation - ApiFlowRevision - `flow` union, required: The flow at this revision level - ApiContactFlow - `actions` union[], required - union - ApiStaticBranchAction - `actionId` string, required: The unique identifier for this static branch action. - `defaultBranch` ApiConnection - … - `defaultBranchName` string: The name of the default branch in the static branch action. - `inputValue` union, required: Represents the input value for the static branch action, which can be of various types such as action data, object property, or static value. - … - `staticBranches` ApiStaticBranch[], required - … - `type` 'STATIC_BRANCH', required: Indicates the type of the action, which defaults to STATIC_BRANCH. - ApiListBranchAction - `actionId` string, required: The unique identifier for the list branch action. - `defaultBranch` ApiConnection - … - `defaultBranchName` string: The name of the default branch in the list action. - `listBranches` ApiListBranch[], required - … - `type` 'LIST_BRANCH', required: Indicates the type of action, which defaults to LIST_BRANCH. - ApiABTestBranchAction - `actionId` string, required: The unique identifier for the A/B test branch action. - `testBranches` ApiABTestBranch[], required - … - `type` 'AB_TEST_BRANCH', required: Indicates the type of action, which defaults to AB_TEST_BRANCH. - ApiCustomCodeAction - `actionId` string, required: The unique identifier for the custom code action. - `connection` ApiConnection - … - `inputFields` ApiInputVariable[], required - … - `outputFields` ApiEnumerationOutputField[], required - … - `runtime` string, required: Specifies the runtime environment for the custom code action. - `secretNames` string[], required - `sourceCode` string, required: Contains the source code for the custom code action. - `type` 'CUSTOM_CODE', required: Indicates the type of the action, which defaults to CUSTOM_CODE. - ApiWebhookAction - `actionId` string, required: The unique identifier for the webhook action. - `authSettings` union: Defines the authentication settings for the webhook, which can include an authentication key or a signature. - … - `body` union - … - `connection` ApiConnection - … - `method` 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE', required: Specifies the HTTP method to be used for the webhook request, with accepted values including CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE. - `queryParams` ApiInputVariable[], required - … - `type` 'WEBHOOK', required: Indicates the type of action, which defaults to WEBHOOK. - `webhookUrl` string, required: The URL to which the webhook request will be sent. - ApiSingleConnectionAction - `actionId` string, required: The unique identifier for the single connection action. - `actionTypeId` string, required: The identifier for the type of action being performed. - `actionTypeVersion` integer, required: Specifies the version of the action type. - `connection` ApiConnection - … - `fields` object, required: Contains the fields associated with the single connection action. - `type` 'SINGLE_CONNECTION', required: Indicates the type of the action, which defaults to SINGLE_CONNECTION. - ApiCriteriaBranchAction - `actionId` string, required - `branches` ApiCriteriaBranch[], required - … - `defaultBranch` ApiConnection - … - `defaultBranchName` string - `type` 'CRITERIA_BRANCH', required - `blockedDates` ApiBlockedDate[], required - `dayOfMonth` integer, required: The day of the month for the blocked date. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required: The month of the blocked date, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `year` integer: The year of the blocked date. - `canEnrollFromSalesforce` boolean, required - `createdAt` string, date-time, required - `crmObjectCreationStatus` 'COMPLETE' | 'PENDING', required - `customProperties` object, required - `dataSources` union[], required - union - ApiAssociationDataSource - `associationCategory` 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK', required: Defines the category of the association, with possible values being HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. - `associationTypeId` integer, required: The ID representing the type of association. - `name` string, required: The name of the data source. - `objectTypeId` string, required: Represents the ID of the object type associated with the data source. - `sortBy` ApiSort - … - `type` 'ASSOCIATION', required: Indicates the type of data source, which defaults to ASSOCIATION. - ApiAssociationTimestampDataSource - `associationCategory` 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK', required: Defines the category of the association, with possible values being HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. - `associationTypeId` integer, required: The ID representing the type of association. - `name` string, required: Specifies the name of the data source. - `objectTypeId` string, required: Represents the ID of the object type associated with the data source. - `type` 'ASSOCIATION_TIMESTAMP', required: Indicates the type of the data source, which defaults to ASSOCIATION_TIMESTAMP. - ApiStaticPropertyFilterDataSource - `name` string, required: Defines the name of the data source. - `propertyName` string, required: Specifies the name of the property used in the static property filter. - `sortBy` ApiSort - … - `staticValue` string, required: Represents the static value used in the property filter. - `type` 'STATIC_PROPERTY_FILTER', required: Indicates the type of data source, which defaults to STATIC_PROPERTY_FILTER. - ApiEnrolledRecordPropertyFilterDataSource - `name` string, required: Defines the name of the data source. - `propertyName` string, required: Specifies the name of the property used in the enrolled record property filter. - `recordFieldName` string, required: The name of the field in the record that is being filtered. - `sortBy` ApiSort - … - `type` 'ENROLLED_RECORD_PROPERTY_FILTER', required: Indicates the type of data source, which defaults to ENROLLED_RECORD_PROPERTY_FILTER. - ApiDatasetFieldPropertyFilterDataSource - `datasetFieldName` string, required: Specifies the name of the dataset field used in the property filter. - `name` string, required: Defines the name of the data source. - `propertyName` string, required: Specifies the name of the property used in the dataset field property filter. - `sortBy` ApiSort - … - `type` 'DATASET_FIELD_PROPERTY_FILTER', required: Indicates the type of data source, which defaults to DATASET_FIELD_PROPERTY_FILTER. - ApiEnrolledArgumentPropertyFilterDataSource - `argumentName` string, required: The name of the argument used in the enrolled argument property filter. - `name` string, required: Defines the name of the data source. - `propertyName` string, required: Specifies the name of the property used in the enrolled argument property filter. - `sortBy` ApiSort - … - `type` 'ENROLLED_ARGUMENT_PROPERTY_FILTER', required: Indicates the type of data source, which defaults to ENROLLED_ARGUMENT_PROPERTY_FILTER. - `description` string - `enrollmentCriteria` union - ApiListBasedEnrollmentCriteria - `listFilterBranch` union, required: Defines the filter branch used to determine list-based enrollment criteria. - PublicOrFilterBranch: The PublicOrFilterBranch component represents a logical 'OR' filter branch used in constructing complex filter criteria within the ListAppService API. It is used to group multiple filters or filter branches, where any of the conditions can be true for the branch to be satisfied. - … - PublicAndFilterBranch: Represents a logical 'AND' filter branch used in constructing complex filter criteria for lists in the HubSpot ListAppService API. This component is utilized to group multiple filters and sub-branches that must all be true for the branch to be considered true. - … - PublicNotAllFilterBranch: The PublicNotAllFilterBranch component represents a filter branch used in HubSpot's ListAppService API to define complex filtering logic where not all conditions need to be met. It is typically used in scenarios where a combination of filters and filter branches are applied to refine data retrieval. - … - PublicNotAnyFilterBranch: Represents a filter branch in a list operation that excludes any filters or branches that match the specified criteria. It is used within the context of defining complex filter logic for lists in the ListAppService API. - … - PublicRestrictedFilterBranch: The PublicRestrictedFilterBranch component represents a specific type of filter branch used within the ListAppService API. It is utilized to apply restrictions on filter branches and filters, allowing for complex query operations within lists. - … - PublicUnifiedEventsFilterBranch: The PublicUnifiedEventsFilterBranch component represents a filter branch specifically for unified events within HubSpot's API. It is used to define criteria for filtering events based on specific conditions and is typically utilized in constructing complex filter logic for event data. - … - PublicAssociationFilterBranch: Represents a branch of filters specifically for associations in the HubSpot API. This component is used to define complex filtering logic involving associations between objects, typically in the context of search or list operations. - … - `reEnrollmentTriggersFilterBranches` union[], required - union - … - `shouldReEnroll` boolean, required: Determines if objects should be re-enrolled when they meet the criteria again. - `type` 'LIST_BASED', required: Specifies the type of enrollment criteria, which defaults to 'LIST_BASED'. - `unEnrollObjectsNotMeetingCriteria` boolean, required: Indicates whether objects not meeting the criteria should be unenrolled. - ApiEventBasedEnrollmentCriteria - `eventFilterBranches` PublicUnifiedEventsFilterBranch[], required - `coalescingRefineBy` union: Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - … - `eventTypeId` string, required: The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required: Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required: An array of nested filter branches, allowing for complex filter logic. Each item can be one of several filter branch types. - … - `filters` union[], required: An array of filters applied to the events. Each filter can be one of several predefined filter types. - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required: Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union: An optional refinement criterion used to prune event data. It can be one of several predefined refinement types. - … - `listMembershipFilterBranches` union[], required - union - … - `refinementCriteria` union: Specifies additional criteria for refining the enrollment process. - PublicOrFilterBranch: The PublicOrFilterBranch component represents a logical 'OR' filter branch used in constructing complex filter criteria within the ListAppService API. It is used to group multiple filters or filter branches, where any of the conditions can be true for the branch to be satisfied. - … - PublicAndFilterBranch: Represents a logical 'AND' filter branch used in constructing complex filter criteria for lists in the HubSpot ListAppService API. This component is utilized to group multiple filters and sub-branches that must all be true for the branch to be considered true. - … - PublicNotAllFilterBranch: The PublicNotAllFilterBranch component represents a filter branch used in HubSpot's ListAppService API to define complex filtering logic where not all conditions need to be met. It is typically used in scenarios where a combination of filters and filter branches are applied to refine data retrieval. - … - PublicNotAnyFilterBranch: Represents a filter branch in a list operation that excludes any filters or branches that match the specified criteria. It is used within the context of defining complex filter logic for lists in the ListAppService API. - … - PublicRestrictedFilterBranch: The PublicRestrictedFilterBranch component represents a specific type of filter branch used within the ListAppService API. It is utilized to apply restrictions on filter branches and filters, allowing for complex query operations within lists. - … - PublicUnifiedEventsFilterBranch: The PublicUnifiedEventsFilterBranch component represents a filter branch specifically for unified events within HubSpot's API. It is used to define criteria for filtering events based on specific conditions and is typically utilized in constructing complex filter logic for event data. - … - PublicAssociationFilterBranch: Represents a branch of filters specifically for associations in the HubSpot API. This component is used to define complex filtering logic involving associations between objects, typically in the context of search or list operations. - … - `shouldReEnroll` boolean, required: Determines if objects should be re-enrolled when they meet the criteria again. - `type` 'EVENT_BASED', required: Specifies the type of enrollment criteria, which defaults to 'EVENT_BASED'. - ApiManualEnrollmentCriteria - `shouldReEnroll` boolean, required: Indicates whether the enrollment should be repeated. - `type` 'MANUAL', required: Specifies the type of enrollment criteria, which is 'MANUAL'. - ApiDatasetBasedEnrollmentCriteria - `datasetId` integer, required - `shouldReEnroll` boolean, required - `subviewId` string - `type` 'DATASET', required - `enrollmentSchedule` union - ApiDailyEnrollmentSchedule - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'DAILY', required: Specifies the type of enrollment schedule, which is 'DAILY'. - ApiWeeklyEnrollmentSchedule - `daysOfWeek` string[], required - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'WEEKLY', required: Indicates the type of enrollment schedule, which is 'WEEKLY'. - ApiMonthlySpecificDaysEnrollmentSchedule - `daysOfMonth` integer[], required - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'MONTHLY_SPECIFIC_DAYS', required: Specifies the type of enrollment schedule, which is 'MONTHLY_SPECIFIC_DAYS'. - ApiMonthlyRelativeDaysEnrollmentSchedule - `monthlyRelativeDays` 'FIRST_MONDAY_OF_MONTH' | 'LAST_DAY_OF_MONTH', required: One of the possible relative days to enroll can be: LAST_DAY_OF_MONTH, or FIRST_MONDAY_OF_MONTH - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'MONTHLY_RELATIVE_DAYS', required: The type of schedule, always: MONTHLY_RELATIVE_DAYS - ApiYearlyEnrollmentSchedule - `dayOfMonth` integer, required: The day of the month for the yearly enrollment schedule. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required: The month for the yearly enrollment schedule, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'YEARLY', required: Indicates the type of enrollment schedule, which defaults to 'YEARLY'. - ApiPropertyBasedEnrollmentSchedule - `dateProperty` string, required: The property used to determine the date for enrollment scheduling. - `daysDelta` integer, required: The number of days to adjust the enrollment date relative to the dateProperty. - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'PROPERTY_BASED', required: Specifies the type of enrollment schedule, which is 'PROPERTY_BASED'. - `yearly` boolean, required: Indicates whether the enrollment schedule is set to repeat annually. - `eventAnchor` union - ApiContactPropertyAnchor - `contactProperty` string, required: Specifies the contact property associated with the anchor. - `type` 'CONTACT_PROPERTY_ANCHOR', required: Indicates the type of the contact property anchor, which defaults to CONTACT_PROPERTY_ANCHOR. - ApiStaticDateAnchor - `dayOfMonth` integer, required: The day of the month for the static date anchor. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required: The month component of the static date anchor, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `type` 'STATIC_DATE_ANCHOR', required: Indicates the type of the date anchor, which defaults to STATIC_DATE_ANCHOR. - `year` integer: The year component of the static date anchor. - `flowType` 'ACTION_SET' | 'UNKNOWN' | 'WORKFLOW', required - `goalFilterBranch` union - PublicOrFilterBranch: The PublicOrFilterBranch component represents a logical 'OR' filter branch used in constructing complex filter criteria within the ListAppService API. It is used to group multiple filters or filter branches, where any of the conditions can be true for the branch to be satisfied. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required: Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required: An array of nested filter branches, allowing for the combination of multiple logical conditions within the 'OR' branch. - union - … - `filters` union[], required: An array of individual filters that are part of the 'OR' branch. Each filter represents a specific condition that can be evaluated. - union - … - PublicAndFilterBranch: Represents a logical 'AND' filter branch used in constructing complex filter criteria for lists in the HubSpot ListAppService API. This component is utilized to group multiple filters and sub-branches that must all be true for the branch to be considered true. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required: Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required: An array of nested filter branches. Each item can be a branch of various types, such as 'OR', 'AND', 'NOT_ALL', etc. - union - … - `filters` union[], required: An array of filters that apply to this branch. Each filter can be of various types, such as property filters, event filters, or subscription filters. - union - … - PublicNotAllFilterBranch: The PublicNotAllFilterBranch component represents a filter branch used in HubSpot's ListAppService API to define complex filtering logic where not all conditions need to be met. It is typically used in scenarios where a combination of filters and filter branches are applied to refine data retrieval. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required: Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required: An array of filter branches that can include various types such as PublicOrFilterBranch, PublicAndFilterBranch, and others, allowing for nested filtering logic. - union - … - `filters` union[], required: An array of filters that can include various types such as PublicPropertyFilter, PublicAssociationInListFilter, and others, used to apply specific conditions to the data. - union - … - PublicNotAnyFilterBranch: Represents a filter branch in a list operation that excludes any filters or branches that match the specified criteria. It is used within the context of defining complex filter logic for lists in the ListAppService API. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required: Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required: An array of filter branches that can include various types such as 'PublicOrFilterBranch', 'PublicAndFilterBranch', 'PublicNotAllFilterBranch', 'PublicNotAnyFilterBranch', 'PublicRestrictedFilterBranch', 'PublicUnifiedEventsFilterBranch', and 'PublicAssociationFilterBranch'. - union - … - `filters` union[], required: An array of filters that can include types like 'PublicPropertyFilter', 'PublicAssociationInListFilter', 'PublicPageViewAnalyticsFilter', 'PublicCtaAnalyticsFilter', 'PublicEventAnalyticsFilter', 'PublicFormSubmissionFilter', 'PublicFormSubmissionOnPageFilter', 'PublicIntegrationEventFilter', 'PublicEmailSubscriptionFilter', 'PublicCommunicationSubscriptionFilter', 'PublicSurveyMonkeyFilter', 'PublicSurveyMonkeyValueFilter', 'PublicWebinarFilter', 'PublicEmailEventFilter', 'PublicPrivacyAnalyticsFilter', 'PublicAdsSearchFilter', 'PublicAdsTimeFilter', 'PublicInListFilter', 'PublicUnifiedEventsFilter', and 'PublicConstantFilter'. - union - … - PublicRestrictedFilterBranch: The PublicRestrictedFilterBranch component represents a specific type of filter branch used within the ListAppService API. It is utilized to apply restrictions on filter branches and filters, allowing for complex query operations within lists. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required: Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required: An array of nested filter branches, which can include various types such as 'PublicOrFilterBranch', 'PublicAndFilterBranch', and others. - union - … - `filters` union[], required: An array of filters applied within the branch, which can include different filter types like 'PublicPropertyFilter', 'PublicAssociationInListFilter', and more. - union - … - PublicUnifiedEventsFilterBranch: The PublicUnifiedEventsFilterBranch component represents a filter branch specifically for unified events within HubSpot's API. It is used to define criteria for filtering events based on specific conditions and is typically utilized in constructing complex filter logic for event data. - `coalescingRefineBy` union: Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - PublicNumOccurrencesRefineBy: Represents a refinement criterion based on the number of occurrences, used in filtering operations within the ListAppService API. This component is typically used to specify the minimum and maximum number of times an event or condition should occur. - … - PublicSetOccurrencesRefineBy: Represents a refinement criterion for filtering based on a set number of occurrences. This component is used within filter operations to specify how occurrences should be refined. - … - PublicRelativeComparativeTimestampRefineBy: Represents a refinement criterion for timestamp-based filters in a relative comparative manner. This component is used to specify conditions for filtering data based on relative time comparisons. - … - PublicRelativeRangedTimestampRefineBy: Represents a refinement filter for timestamp-based criteria within a relative range. It is used in scenarios where filtering by a time range relative to the current time is necessary. - … - PublicAbsoluteComparativeTimestampRefineBy: The PublicAbsoluteComparativeTimestampRefineBy component is used to refine timestamp-based filters in HubSpot's ListAppService API. It specifies an absolute timestamp and a comparison type to filter data based on specific time criteria. - … - PublicAbsoluteRangedTimestampRefineBy: The PublicAbsoluteRangedTimestampRefineBy component is used to define a filter based on an absolute time range. It specifies a fixed lower and upper timestamp to refine results in API requests, particularly for filtering data within a specific time period. - … - PublicAllHistoryRefineBy: The PublicAllHistoryRefineBy component is used to specify a refinement criterion that considers all historical data. It is typically used within filter operations to ensure that all past occurrences are taken into account. - … - PublicTimePointOperation: Represents a time point operation used in filtering or querying data based on specific time-related criteria. This component is typically used in scenarios where time-based operations are required, such as filtering records by a specific date or time point. - … - PublicRangedTimeOperation: Represents a time-based range operation used within the ListAppService API to filter or manipulate data based on time constraints. This component is utilized in scenarios where operations need to consider a range of time points, such as filtering records within a specific time frame. - … - `eventTypeId` string, required: The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required: Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required: An array of nested filter branches, allowing for complex filter logic. Each item can be one of several filter branch types. - union - … - `filters` union[], required: An array of filters applied to the events. Each filter can be one of several predefined filter types. - union - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required: Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union: An optional refinement criterion used to prune event data. It can be one of several predefined refinement types. - PublicNumOccurrencesRefineBy: Represents a refinement criterion based on the number of occurrences, used in filtering operations within the ListAppService API. This component is typically used to specify the minimum and maximum number of times an event or condition should occur. - … - PublicSetOccurrencesRefineBy: Represents a refinement criterion for filtering based on a set number of occurrences. This component is used within filter operations to specify how occurrences should be refined. - … - PublicRelativeComparativeTimestampRefineBy: Represents a refinement criterion for timestamp-based filters in a relative comparative manner. This component is used to specify conditions for filtering data based on relative time comparisons. - … - PublicRelativeRangedTimestampRefineBy: Represents a refinement filter for timestamp-based criteria within a relative range. It is used in scenarios where filtering by a time range relative to the current time is necessary. - … - PublicAbsoluteComparativeTimestampRefineBy: The PublicAbsoluteComparativeTimestampRefineBy component is used to refine timestamp-based filters in HubSpot's ListAppService API. It specifies an absolute timestamp and a comparison type to filter data based on specific time criteria. - … - PublicAbsoluteRangedTimestampRefineBy: The PublicAbsoluteRangedTimestampRefineBy component is used to define a filter based on an absolute time range. It specifies a fixed lower and upper timestamp to refine results in API requests, particularly for filtering data within a specific time period. - … - PublicAllHistoryRefineBy: The PublicAllHistoryRefineBy component is used to specify a refinement criterion that considers all historical data. It is typically used within filter operations to ensure that all past occurrences are taken into account. - … - PublicTimePointOperation: Represents a time point operation used in filtering or querying data based on specific time-related criteria. This component is typically used in scenarios where time-based operations are required, such as filtering records by a specific date or time point. - … - PublicRangedTimeOperation: Represents a time-based range operation used within the ListAppService API to filter or manipulate data based on time constraints. This component is utilized in scenarios where operations need to consider a range of time points, such as filtering records within a specific time frame. - … - PublicAssociationFilterBranch: Represents a branch of filters specifically for associations in the HubSpot API. This component is used to define complex filtering logic involving associations between objects, typically in the context of search or list operations. - `associationCategory` string, required: Defines the category of the association. - `associationTypeId` integer, required: The ID representing the type of association. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required: Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required: An array of nested filter branches, allowing for complex logical groupings of filters. - union - … - `filters` union[], required: An array of filters applied within this branch, each defining specific criteria for filtering associations. - union - … - `objectTypeId` string, required: Represents the ID of the object type associated with the filter branch. - `operator` string, required: Specifies the operator applied to the association filter. - `id` string, required - `isEnabled` boolean, required - `name` string - `nextAvailableActionId` string, required - `objectTypeId` string, required - `revisionId` string, required - `startActionId` string - `suppressionListIds` integer[], required - `timeWindows` ApiTimeWindow[], required - `day` 'FRIDAY' | 'MONDAY' | 'SATURDAY' | 'SUNDAY' | 'THURSDAY' | 'TUESDAY' | 'WEDNESDAY', required: Specifies the day of the week for the time window, with accepted values being: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY. - `endTime` ApiTimeOfDay - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `startTime` ApiTimeOfDay - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'CONTACT_FLOW', required - `unEnrollmentSetting` ApiUnEnrollmentSetting - `flowIds` string[], required - `type` 'ALL' | 'SELECTIVE', required: Specifies the type of unenrollment setting, with possible values being ALL or SELECTIVE. - `updatedAt` string, date-time, required - `uuid` string - ApiPlatformFlow - `actions` union[], required - union - ApiStaticBranchAction - `actionId` string, required: The unique identifier for this static branch action. - `defaultBranch` ApiConnection - … - `defaultBranchName` string: The name of the default branch in the static branch action. - `inputValue` union, required: Represents the input value for the static branch action, which can be of various types such as action data, object property, or static value. - … - `staticBranches` ApiStaticBranch[], required - … - `type` 'STATIC_BRANCH', required: Indicates the type of the action, which defaults to STATIC_BRANCH. - ApiListBranchAction - `actionId` string, required: The unique identifier for the list branch action. - `defaultBranch` ApiConnection - … - `defaultBranchName` string: The name of the default branch in the list action. - `listBranches` ApiListBranch[], required - … - `type` 'LIST_BRANCH', required: Indicates the type of action, which defaults to LIST_BRANCH. - ApiABTestBranchAction - `actionId` string, required: The unique identifier for the A/B test branch action. - `testBranches` ApiABTestBranch[], required - … - `type` 'AB_TEST_BRANCH', required: Indicates the type of action, which defaults to AB_TEST_BRANCH. - ApiCustomCodeAction - `actionId` string, required: The unique identifier for the custom code action. - `connection` ApiConnection - … - `inputFields` ApiInputVariable[], required - … - `outputFields` ApiEnumerationOutputField[], required - … - `runtime` string, required: Specifies the runtime environment for the custom code action. - `secretNames` string[], required - `sourceCode` string, required: Contains the source code for the custom code action. - `type` 'CUSTOM_CODE', required: Indicates the type of the action, which defaults to CUSTOM_CODE. - ApiWebhookAction - `actionId` string, required: The unique identifier for the webhook action. - `authSettings` union: Defines the authentication settings for the webhook, which can include an authentication key or a signature. - … - `body` union - … - `connection` ApiConnection - … - `method` 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE', required: Specifies the HTTP method to be used for the webhook request, with accepted values including CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE. - `queryParams` ApiInputVariable[], required - … - `type` 'WEBHOOK', required: Indicates the type of action, which defaults to WEBHOOK. - `webhookUrl` string, required: The URL to which the webhook request will be sent. - ApiSingleConnectionAction - `actionId` string, required: The unique identifier for the single connection action. - `actionTypeId` string, required: The identifier for the type of action being performed. - `actionTypeVersion` integer, required: Specifies the version of the action type. - `connection` ApiConnection - … - `fields` object, required: Contains the fields associated with the single connection action. - `type` 'SINGLE_CONNECTION', required: Indicates the type of the action, which defaults to SINGLE_CONNECTION. - ApiCriteriaBranchAction - `actionId` string, required - `branches` ApiCriteriaBranch[], required - … - `defaultBranch` ApiConnection - … - `defaultBranchName` string - `type` 'CRITERIA_BRANCH', required - `blockedDates` ApiBlockedDate[], required - `dayOfMonth` integer, required: The day of the month for the blocked date. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required: The month of the blocked date, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `year` integer: The year of the blocked date. - `createdAt` string, date-time, required - `crmObjectCreationStatus` 'COMPLETE' | 'PENDING', required - `customProperties` object, required - `dataSources` union[], required - union - ApiAssociationDataSource - `associationCategory` 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK', required: Defines the category of the association, with possible values being HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. - `associationTypeId` integer, required: The ID representing the type of association. - `name` string, required: The name of the data source. - `objectTypeId` string, required: Represents the ID of the object type associated with the data source. - `sortBy` ApiSort - … - `type` 'ASSOCIATION', required: Indicates the type of data source, which defaults to ASSOCIATION. - ApiAssociationTimestampDataSource - `associationCategory` 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK', required: Defines the category of the association, with possible values being HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. - `associationTypeId` integer, required: The ID representing the type of association. - `name` string, required: Specifies the name of the data source. - `objectTypeId` string, required: Represents the ID of the object type associated with the data source. - `type` 'ASSOCIATION_TIMESTAMP', required: Indicates the type of the data source, which defaults to ASSOCIATION_TIMESTAMP. - ApiStaticPropertyFilterDataSource - `name` string, required: Defines the name of the data source. - `propertyName` string, required: Specifies the name of the property used in the static property filter. - `sortBy` ApiSort - … - `staticValue` string, required: Represents the static value used in the property filter. - `type` 'STATIC_PROPERTY_FILTER', required: Indicates the type of data source, which defaults to STATIC_PROPERTY_FILTER. - ApiEnrolledRecordPropertyFilterDataSource - `name` string, required: Defines the name of the data source. - `propertyName` string, required: Specifies the name of the property used in the enrolled record property filter. - `recordFieldName` string, required: The name of the field in the record that is being filtered. - `sortBy` ApiSort - … - `type` 'ENROLLED_RECORD_PROPERTY_FILTER', required: Indicates the type of data source, which defaults to ENROLLED_RECORD_PROPERTY_FILTER. - ApiDatasetFieldPropertyFilterDataSource - `datasetFieldName` string, required: Specifies the name of the dataset field used in the property filter. - `name` string, required: Defines the name of the data source. - `propertyName` string, required: Specifies the name of the property used in the dataset field property filter. - `sortBy` ApiSort - … - `type` 'DATASET_FIELD_PROPERTY_FILTER', required: Indicates the type of data source, which defaults to DATASET_FIELD_PROPERTY_FILTER. - ApiEnrolledArgumentPropertyFilterDataSource - `argumentName` string, required: The name of the argument used in the enrolled argument property filter. - `name` string, required: Defines the name of the data source. - `propertyName` string, required: Specifies the name of the property used in the enrolled argument property filter. - `sortBy` ApiSort - … - `type` 'ENROLLED_ARGUMENT_PROPERTY_FILTER', required: Indicates the type of data source, which defaults to ENROLLED_ARGUMENT_PROPERTY_FILTER. - `description` string - `enrollmentCriteria` union - ApiListBasedEnrollmentCriteria - `listFilterBranch` union, required: Defines the filter branch used to determine list-based enrollment criteria. - PublicOrFilterBranch: The PublicOrFilterBranch component represents a logical 'OR' filter branch used in constructing complex filter criteria within the ListAppService API. It is used to group multiple filters or filter branches, where any of the conditions can be true for the branch to be satisfied. - … - PublicAndFilterBranch: Represents a logical 'AND' filter branch used in constructing complex filter criteria for lists in the HubSpot ListAppService API. This component is utilized to group multiple filters and sub-branches that must all be true for the branch to be considered true. - … - PublicNotAllFilterBranch: The PublicNotAllFilterBranch component represents a filter branch used in HubSpot's ListAppService API to define complex filtering logic where not all conditions need to be met. It is typically used in scenarios where a combination of filters and filter branches are applied to refine data retrieval. - … - PublicNotAnyFilterBranch: Represents a filter branch in a list operation that excludes any filters or branches that match the specified criteria. It is used within the context of defining complex filter logic for lists in the ListAppService API. - … - PublicRestrictedFilterBranch: The PublicRestrictedFilterBranch component represents a specific type of filter branch used within the ListAppService API. It is utilized to apply restrictions on filter branches and filters, allowing for complex query operations within lists. - … - PublicUnifiedEventsFilterBranch: The PublicUnifiedEventsFilterBranch component represents a filter branch specifically for unified events within HubSpot's API. It is used to define criteria for filtering events based on specific conditions and is typically utilized in constructing complex filter logic for event data. - … - PublicAssociationFilterBranch: Represents a branch of filters specifically for associations in the HubSpot API. This component is used to define complex filtering logic involving associations between objects, typically in the context of search or list operations. - … - `reEnrollmentTriggersFilterBranches` union[], required - union - … - `shouldReEnroll` boolean, required: Determines if objects should be re-enrolled when they meet the criteria again. - `type` 'LIST_BASED', required: Specifies the type of enrollment criteria, which defaults to 'LIST_BASED'. - `unEnrollObjectsNotMeetingCriteria` boolean, required: Indicates whether objects not meeting the criteria should be unenrolled. - ApiEventBasedEnrollmentCriteria - `eventFilterBranches` PublicUnifiedEventsFilterBranch[], required - `coalescingRefineBy` union: Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - … - `eventTypeId` string, required: The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required: Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required: An array of nested filter branches, allowing for complex filter logic. Each item can be one of several filter branch types. - … - `filters` union[], required: An array of filters applied to the events. Each filter can be one of several predefined filter types. - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required: Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union: An optional refinement criterion used to prune event data. It can be one of several predefined refinement types. - … - `listMembershipFilterBranches` union[], required - union - … - `refinementCriteria` union: Specifies additional criteria for refining the enrollment process. - PublicOrFilterBranch: The PublicOrFilterBranch component represents a logical 'OR' filter branch used in constructing complex filter criteria within the ListAppService API. It is used to group multiple filters or filter branches, where any of the conditions can be true for the branch to be satisfied. - … - PublicAndFilterBranch: Represents a logical 'AND' filter branch used in constructing complex filter criteria for lists in the HubSpot ListAppService API. This component is utilized to group multiple filters and sub-branches that must all be true for the branch to be considered true. - … - PublicNotAllFilterBranch: The PublicNotAllFilterBranch component represents a filter branch used in HubSpot's ListAppService API to define complex filtering logic where not all conditions need to be met. It is typically used in scenarios where a combination of filters and filter branches are applied to refine data retrieval. - … - PublicNotAnyFilterBranch: Represents a filter branch in a list operation that excludes any filters or branches that match the specified criteria. It is used within the context of defining complex filter logic for lists in the ListAppService API. - … - PublicRestrictedFilterBranch: The PublicRestrictedFilterBranch component represents a specific type of filter branch used within the ListAppService API. It is utilized to apply restrictions on filter branches and filters, allowing for complex query operations within lists. - … - PublicUnifiedEventsFilterBranch: The PublicUnifiedEventsFilterBranch component represents a filter branch specifically for unified events within HubSpot's API. It is used to define criteria for filtering events based on specific conditions and is typically utilized in constructing complex filter logic for event data. - … - PublicAssociationFilterBranch: Represents a branch of filters specifically for associations in the HubSpot API. This component is used to define complex filtering logic involving associations between objects, typically in the context of search or list operations. - … - `shouldReEnroll` boolean, required: Determines if objects should be re-enrolled when they meet the criteria again. - `type` 'EVENT_BASED', required: Specifies the type of enrollment criteria, which defaults to 'EVENT_BASED'. - ApiManualEnrollmentCriteria - `shouldReEnroll` boolean, required: Indicates whether the enrollment should be repeated. - `type` 'MANUAL', required: Specifies the type of enrollment criteria, which is 'MANUAL'. - ApiDatasetBasedEnrollmentCriteria - `datasetId` integer, required - `shouldReEnroll` boolean, required - `subviewId` string - `type` 'DATASET', required - `enrollmentSchedule` union - ApiDailyEnrollmentSchedule - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'DAILY', required: Specifies the type of enrollment schedule, which is 'DAILY'. - ApiWeeklyEnrollmentSchedule - `daysOfWeek` string[], required - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'WEEKLY', required: Indicates the type of enrollment schedule, which is 'WEEKLY'. - ApiMonthlySpecificDaysEnrollmentSchedule - `daysOfMonth` integer[], required - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'MONTHLY_SPECIFIC_DAYS', required: Specifies the type of enrollment schedule, which is 'MONTHLY_SPECIFIC_DAYS'. - ApiMonthlyRelativeDaysEnrollmentSchedule - `monthlyRelativeDays` 'FIRST_MONDAY_OF_MONTH' | 'LAST_DAY_OF_MONTH', required: One of the possible relative days to enroll can be: LAST_DAY_OF_MONTH, or FIRST_MONDAY_OF_MONTH - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'MONTHLY_RELATIVE_DAYS', required: The type of schedule, always: MONTHLY_RELATIVE_DAYS - ApiYearlyEnrollmentSchedule - `dayOfMonth` integer, required: The day of the month for the yearly enrollment schedule. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required: The month for the yearly enrollment schedule, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'YEARLY', required: Indicates the type of enrollment schedule, which defaults to 'YEARLY'. - ApiPropertyBasedEnrollmentSchedule - `dateProperty` string, required: The property used to determine the date for enrollment scheduling. - `daysDelta` integer, required: The number of days to adjust the enrollment date relative to the dateProperty. - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'PROPERTY_BASED', required: Specifies the type of enrollment schedule, which is 'PROPERTY_BASED'. - `yearly` boolean, required: Indicates whether the enrollment schedule is set to repeat annually. - `flowType` 'ACTION_SET' | 'UNKNOWN' | 'WORKFLOW', required - `id` string, required - `isEnabled` boolean, required - `name` string - `nextAvailableActionId` string, required - `objectTypeId` string, required - `revisionId` string, required - `startActionId` string - `suppressionFilterBranch` union - PublicOrFilterBranch: The PublicOrFilterBranch component represents a logical 'OR' filter branch used in constructing complex filter criteria within the ListAppService API. It is used to group multiple filters or filter branches, where any of the conditions can be true for the branch to be satisfied. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required: Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required: An array of nested filter branches, allowing for the combination of multiple logical conditions within the 'OR' branch. - union - … - `filters` union[], required: An array of individual filters that are part of the 'OR' branch. Each filter represents a specific condition that can be evaluated. - union - … - PublicAndFilterBranch: Represents a logical 'AND' filter branch used in constructing complex filter criteria for lists in the HubSpot ListAppService API. This component is utilized to group multiple filters and sub-branches that must all be true for the branch to be considered true. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required: Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required: An array of nested filter branches. Each item can be a branch of various types, such as 'OR', 'AND', 'NOT_ALL', etc. - union - … - `filters` union[], required: An array of filters that apply to this branch. Each filter can be of various types, such as property filters, event filters, or subscription filters. - union - … - PublicNotAllFilterBranch: The PublicNotAllFilterBranch component represents a filter branch used in HubSpot's ListAppService API to define complex filtering logic where not all conditions need to be met. It is typically used in scenarios where a combination of filters and filter branches are applied to refine data retrieval. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required: Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required: An array of filter branches that can include various types such as PublicOrFilterBranch, PublicAndFilterBranch, and others, allowing for nested filtering logic. - union - … - `filters` union[], required: An array of filters that can include various types such as PublicPropertyFilter, PublicAssociationInListFilter, and others, used to apply specific conditions to the data. - union - … - PublicNotAnyFilterBranch: Represents a filter branch in a list operation that excludes any filters or branches that match the specified criteria. It is used within the context of defining complex filter logic for lists in the ListAppService API. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required: Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required: An array of filter branches that can include various types such as 'PublicOrFilterBranch', 'PublicAndFilterBranch', 'PublicNotAllFilterBranch', 'PublicNotAnyFilterBranch', 'PublicRestrictedFilterBranch', 'PublicUnifiedEventsFilterBranch', and 'PublicAssociationFilterBranch'. - union - … - `filters` union[], required: An array of filters that can include types like 'PublicPropertyFilter', 'PublicAssociationInListFilter', 'PublicPageViewAnalyticsFilter', 'PublicCtaAnalyticsFilter', 'PublicEventAnalyticsFilter', 'PublicFormSubmissionFilter', 'PublicFormSubmissionOnPageFilter', 'PublicIntegrationEventFilter', 'PublicEmailSubscriptionFilter', 'PublicCommunicationSubscriptionFilter', 'PublicSurveyMonkeyFilter', 'PublicSurveyMonkeyValueFilter', 'PublicWebinarFilter', 'PublicEmailEventFilter', 'PublicPrivacyAnalyticsFilter', 'PublicAdsSearchFilter', 'PublicAdsTimeFilter', 'PublicInListFilter', 'PublicUnifiedEventsFilter', and 'PublicConstantFilter'. - union - … - PublicRestrictedFilterBranch: The PublicRestrictedFilterBranch component represents a specific type of filter branch used within the ListAppService API. It is utilized to apply restrictions on filter branches and filters, allowing for complex query operations within lists. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required: Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required: An array of nested filter branches, which can include various types such as 'PublicOrFilterBranch', 'PublicAndFilterBranch', and others. - union - … - `filters` union[], required: An array of filters applied within the branch, which can include different filter types like 'PublicPropertyFilter', 'PublicAssociationInListFilter', and more. - union - … - PublicUnifiedEventsFilterBranch: The PublicUnifiedEventsFilterBranch component represents a filter branch specifically for unified events within HubSpot's API. It is used to define criteria for filtering events based on specific conditions and is typically utilized in constructing complex filter logic for event data. - `coalescingRefineBy` union: Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - PublicNumOccurrencesRefineBy: Represents a refinement criterion based on the number of occurrences, used in filtering operations within the ListAppService API. This component is typically used to specify the minimum and maximum number of times an event or condition should occur. - … - PublicSetOccurrencesRefineBy: Represents a refinement criterion for filtering based on a set number of occurrences. This component is used within filter operations to specify how occurrences should be refined. - … - PublicRelativeComparativeTimestampRefineBy: Represents a refinement criterion for timestamp-based filters in a relative comparative manner. This component is used to specify conditions for filtering data based on relative time comparisons. - … - PublicRelativeRangedTimestampRefineBy: Represents a refinement filter for timestamp-based criteria within a relative range. It is used in scenarios where filtering by a time range relative to the current time is necessary. - … - PublicAbsoluteComparativeTimestampRefineBy: The PublicAbsoluteComparativeTimestampRefineBy component is used to refine timestamp-based filters in HubSpot's ListAppService API. It specifies an absolute timestamp and a comparison type to filter data based on specific time criteria. - … - PublicAbsoluteRangedTimestampRefineBy: The PublicAbsoluteRangedTimestampRefineBy component is used to define a filter based on an absolute time range. It specifies a fixed lower and upper timestamp to refine results in API requests, particularly for filtering data within a specific time period. - … - PublicAllHistoryRefineBy: The PublicAllHistoryRefineBy component is used to specify a refinement criterion that considers all historical data. It is typically used within filter operations to ensure that all past occurrences are taken into account. - … - PublicTimePointOperation: Represents a time point operation used in filtering or querying data based on specific time-related criteria. This component is typically used in scenarios where time-based operations are required, such as filtering records by a specific date or time point. - … - PublicRangedTimeOperation: Represents a time-based range operation used within the ListAppService API to filter or manipulate data based on time constraints. This component is utilized in scenarios where operations need to consider a range of time points, such as filtering records within a specific time frame. - … - `eventTypeId` string, required: The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required: Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required: An array of nested filter branches, allowing for complex filter logic. Each item can be one of several filter branch types. - union - … - `filters` union[], required: An array of filters applied to the events. Each filter can be one of several predefined filter types. - union - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required: Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union: An optional refinement criterion used to prune event data. It can be one of several predefined refinement types. - PublicNumOccurrencesRefineBy: Represents a refinement criterion based on the number of occurrences, used in filtering operations within the ListAppService API. This component is typically used to specify the minimum and maximum number of times an event or condition should occur. - … - PublicSetOccurrencesRefineBy: Represents a refinement criterion for filtering based on a set number of occurrences. This component is used within filter operations to specify how occurrences should be refined. - … - PublicRelativeComparativeTimestampRefineBy: Represents a refinement criterion for timestamp-based filters in a relative comparative manner. This component is used to specify conditions for filtering data based on relative time comparisons. - … - PublicRelativeRangedTimestampRefineBy: Represents a refinement filter for timestamp-based criteria within a relative range. It is used in scenarios where filtering by a time range relative to the current time is necessary. - … - PublicAbsoluteComparativeTimestampRefineBy: The PublicAbsoluteComparativeTimestampRefineBy component is used to refine timestamp-based filters in HubSpot's ListAppService API. It specifies an absolute timestamp and a comparison type to filter data based on specific time criteria. - … - PublicAbsoluteRangedTimestampRefineBy: The PublicAbsoluteRangedTimestampRefineBy component is used to define a filter based on an absolute time range. It specifies a fixed lower and upper timestamp to refine results in API requests, particularly for filtering data within a specific time period. - … - PublicAllHistoryRefineBy: The PublicAllHistoryRefineBy component is used to specify a refinement criterion that considers all historical data. It is typically used within filter operations to ensure that all past occurrences are taken into account. - … - PublicTimePointOperation: Represents a time point operation used in filtering or querying data based on specific time-related criteria. This component is typically used in scenarios where time-based operations are required, such as filtering records by a specific date or time point. - … - PublicRangedTimeOperation: Represents a time-based range operation used within the ListAppService API to filter or manipulate data based on time constraints. This component is utilized in scenarios where operations need to consider a range of time points, such as filtering records within a specific time frame. - … - PublicAssociationFilterBranch: Represents a branch of filters specifically for associations in the HubSpot API. This component is used to define complex filtering logic involving associations between objects, typically in the context of search or list operations. - `associationCategory` string, required: Defines the category of the association. - `associationTypeId` integer, required: The ID representing the type of association. - `filterBranchOperator` string, required: Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required: Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required: An array of nested filter branches, allowing for complex logical groupings of filters. - union - … - `filters` union[], required: An array of filters applied within this branch, each defining specific criteria for filtering associations. - union - … - `objectTypeId` string, required: Represents the ID of the object type associated with the filter branch. - `operator` string, required: Specifies the operator applied to the association filter. - `timeWindows` ApiTimeWindow[], required - `day` 'FRIDAY' | 'MONDAY' | 'SATURDAY' | 'SUNDAY' | 'THURSDAY' | 'TUESDAY' | 'WEDNESDAY', required: Specifies the day of the week for the time window, with accepted values being: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY. - `endTime` ApiTimeOfDay - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `startTime` ApiTimeOfDay - `hour` integer, required: The hour component of the time, represented as an integer. - `minute` integer, required: The minute component of the time, represented as an integer. - `type` 'PLATFORM_FLOW', required - `updatedAt` string, date-time, required - `uuid` string - `id` string, required: The flow's ID - `revisionCreatedAt` string, date-time, required: The timestamp this revision was created. - `revisionId` string, required: The revision of this flow ## Other responses - `default`: An error occurred. ## Changes > 98 revisions in range; 5 not diffed. - **2026-11-13** (2026-09-beta) `6ee0f25fe1ee`: 2 info - the security scope `automation` was added to the endpoint's security scheme `oauth2` - the security scope `workflows.read` was removed from the endpoint's security scheme `oauth2` - **2026-10-29** (2026-09-beta) `bf0e045cbe0f`: 2 info - added the optional property `flow/oneOf[#/components/schemas/ApiContactFlow]/actions/items/oneOf[subschema #5: WEBHOOK]/body` to the response with the `200` status - added the optional property `flow/oneOf[#/components/schemas/ApiPlatformFlow]/actions/items/oneOf[subschema #5: WEBHOOK]/body` to the response with the `200` status - …earlier changes not shown [Operation history](https://skmtc.dev/hubspot/apis/automation-automation-v4/changes/automation/2026-09-beta/flows/:flowId/revisions/:revisionId/get.md) --- [API](https://skmtc.dev/hubspot/apis/automation-automation-v4.md) - [All operations](https://skmtc.dev/hubspot/apis/automation-automation-v4/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/automation-automation-v4/revisions/6ee0f25fe1ee?raw)