--- title: "Retrieve multiple automation flows in a single request." method: POST path: "/automation/2026-09-beta/flows/batch/read" tags: ["Batch"] --- # Retrieve multiple automation flows in a single request. `POST /automation/2026-09-beta/flows/batch/read` ## Request - Base URL: `https://api.hubapi.com` - URL: `https://api.hubapi.com/automation/2026-09-beta/flows/batch/read` - 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 multiple automation flows in a single request. This endpoint is useful for efficiently fetching data about several flows at once, reducing the need for multiple API calls. It is ideal for applications that need to process or display information about multiple flows simultaneously. ## Request body - ApiFlowBatchInput - `inputs` ApiFlowBatchFetchFlowIdCoordinate[], required - `flowId` string, required: The unique identifier for the automation flow. - `type` 'FLOW_ID', required: Specifies the type of coordinate:FLOW_ID. ## Response `200` successful operation - BatchResponseApiFlow - `completedAt` string, date-time, required: The date and time when the batch process was completed, formatted as a date-time string. - `links` object: A collection of URLs related to the batch process, empty for this operation. - `requestedAt` string, date-time: The date and time when the batch request was initiated, formatted as a date-time string. - `results` ApiFlow[], required - union - object - `actions` union[], required - union - ApiStaticBranchAction - … - ApiListBranchAction - … - ApiABTestBranchAction - … - ApiCustomCodeAction - … - ApiWebhookAction - … - ApiSingleConnectionAction - … - ApiCriteriaBranchAction - … - `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 - … - ApiAssociationTimestampDataSource - … - ApiStaticPropertyFilterDataSource - … - ApiEnrolledRecordPropertyFilterDataSource - … - ApiDatasetFieldPropertyFilterDataSource - … - ApiEnrolledArgumentPropertyFilterDataSource - … - `description` string - `enrollmentCriteria` union - ApiListBasedEnrollmentCriteria - `listFilterBranch` union, required: Defines the filter branch used to determine list-based enrollment criteria. - … - `reEnrollmentTriggersFilterBranches` union[], required - … - `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 - … - `listMembershipFilterBranches` union[], required - … - `refinementCriteria` union: Specifies additional criteria for refining the enrollment process. - … - `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 - … - `type` 'DAILY', required: Specifies the type of enrollment schedule, which is 'DAILY'. - ApiWeeklyEnrollmentSchedule - `daysOfWeek` string[], required - `timeOfDay` ApiTimeOfDay, required - … - `type` 'WEEKLY', required: Indicates the type of enrollment schedule, which is 'WEEKLY'. - ApiMonthlySpecificDaysEnrollmentSchedule - `daysOfMonth` integer[], required - `timeOfDay` ApiTimeOfDay, required - … - `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 - … - `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 - … - `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 - … - `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. - … - `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. - … - 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. - … - `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. - … - 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. - … - `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. - … - 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'. - … - `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'. - … - 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. - … - `filters` union[], required: An array of filters applied within the branch, which can include different filter types like 'PublicPropertyFilter', 'PublicAssociationInListFilter', and more. - … - 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. - … - `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. - … - 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. - … - `filters` union[], required: An array of filters applied within this branch, each defining specific criteria for filtering associations. - … - `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 - object - `actions` union[], required - union - ApiStaticBranchAction - … - ApiListBranchAction - … - ApiABTestBranchAction - … - ApiCustomCodeAction - … - ApiWebhookAction - … - ApiSingleConnectionAction - … - ApiCriteriaBranchAction - … - `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 - … - ApiAssociationTimestampDataSource - … - ApiStaticPropertyFilterDataSource - … - ApiEnrolledRecordPropertyFilterDataSource - … - ApiDatasetFieldPropertyFilterDataSource - … - ApiEnrolledArgumentPropertyFilterDataSource - … - `description` string - `enrollmentCriteria` union - ApiListBasedEnrollmentCriteria - `listFilterBranch` union, required: Defines the filter branch used to determine list-based enrollment criteria. - … - `reEnrollmentTriggersFilterBranches` union[], required - … - `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 - … - `listMembershipFilterBranches` union[], required - … - `refinementCriteria` union: Specifies additional criteria for refining the enrollment process. - … - `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 - … - `type` 'DAILY', required: Specifies the type of enrollment schedule, which is 'DAILY'. - ApiWeeklyEnrollmentSchedule - `daysOfWeek` string[], required - `timeOfDay` ApiTimeOfDay, required - … - `type` 'WEEKLY', required: Indicates the type of enrollment schedule, which is 'WEEKLY'. - ApiMonthlySpecificDaysEnrollmentSchedule - `daysOfMonth` integer[], required - `timeOfDay` ApiTimeOfDay, required - … - `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 - … - `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 - … - `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 - … - `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. - … - `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. - … - 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. - … - `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. - … - 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. - … - `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. - … - 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'. - … - `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'. - … - 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. - … - `filters` union[], required: An array of filters applied within the branch, which can include different filter types like 'PublicPropertyFilter', 'PublicAssociationInListFilter', and more. - … - 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. - … - `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. - … - 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. - … - `filters` union[], required: An array of filters applied within this branch, each defining specific criteria for filtering associations. - … - `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 - `startedAt` string, date-time, required: The date and time when the batch process began, formatted as a date-time string. - `status` 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING', required: The current status of the batch process, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING. ## Other responses - `207`: multiple statuses - `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`: 4 info - added the optional property `results/items/oneOf[#/components/schemas/ApiContactFlow]/actions/items/oneOf[subschema #5: WEBHOOK]/body` to the response with the `200` status - added the optional property `results/items/oneOf[#/components/schemas/ApiContactFlow]/actions/items/oneOf[subschema #5: WEBHOOK]/body` to the response with the `207` status - added the optional property `results/items/oneOf[#/components/schemas/ApiPlatformFlow]/actions/items/oneOf[subschema #5: WEBHOOK]/body` to the response with the `200` status - added the optional property `results/items/oneOf[#/components/schemas/ApiPlatformFlow]/actions/items/oneOf[subschema #5: WEBHOOK]/body` to the response with the `207` status - …earlier changes not shown [Operation history](https://skmtc.dev/hubspot/apis/automation-automation-v4/changes/automation/2026-09-beta/flows/batch/read/post.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)