/** * Klaviyo API * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. * * Contact: developers@klaviyo.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosResponse } from "axios"; import { FlowActionUpdateQuery } from '../model/flowActionUpdateQuery'; import { FlowCreateQuery } from '../model/flowCreateQuery'; import { FlowUpdateQuery } from '../model/flowUpdateQuery'; import { GetFlowActionEncodedResponse } from '../model/getFlowActionEncodedResponse'; import { GetFlowActionEncodedResponseCollection } from '../model/getFlowActionEncodedResponseCollection'; import { GetFlowActionEncodedResponseCompoundDocument } from '../model/getFlowActionEncodedResponseCompoundDocument'; import { GetFlowActionFlowMessageRelationshipResponseCollection } from '../model/getFlowActionFlowMessageRelationshipResponseCollection'; import { GetFlowActionFlowRelationshipResponse } from '../model/getFlowActionFlowRelationshipResponse'; import { GetFlowFlowActionRelationshipListResponseCollection } from '../model/getFlowFlowActionRelationshipListResponseCollection'; import { GetFlowMessageActionRelationshipResponse } from '../model/getFlowMessageActionRelationshipResponse'; import { GetFlowMessageEncodedResponseCollection } from '../model/getFlowMessageEncodedResponseCollection'; import { GetFlowMessageEncodedResponseCompoundDocument } from '../model/getFlowMessageEncodedResponseCompoundDocument'; import { GetFlowMessageTemplateRelationshipResponse } from '../model/getFlowMessageTemplateRelationshipResponse'; import { GetFlowResponse } from '../model/getFlowResponse'; import { GetFlowResponseCollectionCompoundDocument } from '../model/getFlowResponseCollectionCompoundDocument'; import { GetFlowTagsRelationshipsResponseCollection } from '../model/getFlowTagsRelationshipsResponseCollection'; import { GetFlowV2ResponseCompoundDocument } from '../model/getFlowV2ResponseCompoundDocument'; import { GetTagResponseCollection } from '../model/getTagResponseCollection'; import { GetTemplateResponse } from '../model/getTemplateResponse'; import { PatchFlowActionEncodedResponse } from '../model/patchFlowActionEncodedResponse'; import { PatchFlowResponse } from '../model/patchFlowResponse'; import { PostFlowV2Response } from '../model/postFlowV2Response'; import { Session } from './apis'; export declare class FlowsApi { session: Session; protected _basePath: string; protected _defaultHeaders: any; protected _useQuerystring: boolean; constructor(session: Session); set useQuerystring(value: boolean); set basePath(basePath: string); set defaultHeaders(defaultHeaders: any); get defaultHeaders(): any; get basePath(): string; /** * Create a new flow using an encoded flow definition. New objects within the flow definition, such as actions, will need to use a `temporary_id` field for identification. These will be replaced with traditional `id` fields after successful creation. A successful request will return the new definition to you.

*Rate limits*:
Burst: `1/s`
Steady: `15/m`
Daily: `100/d` **Scopes:** `flows:write` * @summary Create Flow * @param flowCreateQuery Creates a Flow from parameters * @param additionalFieldsFlow Request additional fields not included by default in the response. Supported values: \'definition\' */ createFlow(flowCreateQuery: FlowCreateQuery, options?: { additionalFieldsFlow?: Array<'definition'>; }): Promise<{ response: AxiosResponse; body: PostFlowV2Response; }>; /** * Delete a flow with the given flow ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:write` * @summary Delete Flow * @param id ID of the Flow to delete. Ex: XVTP5Q */ deleteFlow(id: string): Promise<{ response: AxiosResponse; body?: any; }>; /** * Get the flow action for a flow message with the given message ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Action for Flow Message * @param id * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets */ getActionForFlowMessage(id: string, options?: { fieldsFlowAction?: Array<'created' | 'definition' | 'definition.data' | 'definition.data.action_output_filter' | 'definition.data.action_output_filter.condition_groups' | 'definition.data.branches' | 'definition.data.current_experiment' | 'definition.data.current_experiment.allocations' | 'definition.data.current_experiment.automatic_winner_selection_settings' | 'definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date' | 'definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty' | 'definition.data.current_experiment.automatic_winner_selection_settings.enabled' | 'definition.data.current_experiment.id' | 'definition.data.current_experiment.name' | 'definition.data.current_experiment.started' | 'definition.data.current_experiment.variations' | 'definition.data.current_experiment.winner_metric' | 'definition.data.delay_until_time' | 'definition.data.delay_until_weekdays' | 'definition.data.experiment_status' | 'definition.data.list_id' | 'definition.data.main_action' | 'definition.data.main_action.data' | 'definition.data.main_action.data.message' | 'definition.data.main_action.data.message.action_buttons' | 'definition.data.main_action.data.message.add_info_link' | 'definition.data.main_action.data.message.add_opt_out_language' | 'definition.data.main_action.data.message.add_org_prefix' | 'definition.data.main_action.data.message.add_tracking_params' | 'definition.data.main_action.data.message.additional_filters' | 'definition.data.main_action.data.message.additional_filters.condition_groups' | 'definition.data.main_action.data.message.android_link' | 'definition.data.main_action.data.message.badge' | 'definition.data.main_action.data.message.badge_options' | 'definition.data.main_action.data.message.badge_options.badge_config' | 'definition.data.main_action.data.message.badge_options.set_from_property' | 'definition.data.main_action.data.message.badge_options.value' | 'definition.data.main_action.data.message.bcc_email' | 'definition.data.main_action.data.message.body' | 'definition.data.main_action.data.message.cc_email' | 'definition.data.main_action.data.message.conversion_metric_id' | 'definition.data.main_action.data.message.custom_tracking_params' | 'definition.data.main_action.data.message.dynamic_image' | 'definition.data.main_action.data.message.from_email' | 'definition.data.main_action.data.message.from_label' | 'definition.data.main_action.data.message.id' | 'definition.data.main_action.data.message.image_id' | 'definition.data.main_action.data.message.include_contact_card' | 'definition.data.main_action.data.message.ios_link' | 'definition.data.main_action.data.message.kv_pairs' | 'definition.data.main_action.data.message.name' | 'definition.data.main_action.data.message.on_open' | 'definition.data.main_action.data.message.preview_text' | 'definition.data.main_action.data.message.push_type' | 'definition.data.main_action.data.message.reply_to_email' | 'definition.data.main_action.data.message.shorten_links' | 'definition.data.main_action.data.message.smart_sending_enabled' | 'definition.data.main_action.data.message.sms_quiet_hours_enabled' | 'definition.data.main_action.data.message.sound' | 'definition.data.main_action.data.message.subject_line' | 'definition.data.main_action.data.message.template_id' | 'definition.data.main_action.data.message.title' | 'definition.data.main_action.data.message.transactional' | 'definition.data.main_action.data.message.video_asset_id' | 'definition.data.main_action.data.status' | 'definition.data.main_action.id' | 'definition.data.main_action.links' | 'definition.data.main_action.links.next' | 'definition.data.main_action.temporary_id' | 'definition.data.main_action.type' | 'definition.data.message' | 'definition.data.message.action_buttons' | 'definition.data.message.add_info_link' | 'definition.data.message.add_opt_out_language' | 'definition.data.message.add_org_prefix' | 'definition.data.message.add_tracking_params' | 'definition.data.message.additional_filters' | 'definition.data.message.additional_filters.condition_groups' | 'definition.data.message.android_link' | 'definition.data.message.badge' | 'definition.data.message.badge_options' | 'definition.data.message.badge_options.badge_config' | 'definition.data.message.badge_options.set_from_property' | 'definition.data.message.badge_options.value' | 'definition.data.message.bcc_email' | 'definition.data.message.body' | 'definition.data.message.cc_email' | 'definition.data.message.conversion_metric_id' | 'definition.data.message.custom_tracking_params' | 'definition.data.message.dynamic_image' | 'definition.data.message.from_email' | 'definition.data.message.from_label' | 'definition.data.message.headers' | 'definition.data.message.id' | 'definition.data.message.image_id' | 'definition.data.message.include_contact_card' | 'definition.data.message.ios_link' | 'definition.data.message.kv_pairs' | 'definition.data.message.name' | 'definition.data.message.on_open' | 'definition.data.message.preview_text' | 'definition.data.message.push_type' | 'definition.data.message.reply_to_email' | 'definition.data.message.shorten_links' | 'definition.data.message.smart_sending_enabled' | 'definition.data.message.sms_quiet_hours_enabled' | 'definition.data.message.sound' | 'definition.data.message.subject_line' | 'definition.data.message.template_id' | 'definition.data.message.title' | 'definition.data.message.to_emails' | 'definition.data.message.transactional' | 'definition.data.message.url' | 'definition.data.message.vendor_id' | 'definition.data.message.video_asset_id' | 'definition.data.name' | 'definition.data.on_execution' | 'definition.data.profile_filter' | 'definition.data.profile_filter.condition_groups' | 'definition.data.profile_operations' | 'definition.data.secondary_value' | 'definition.data.service_configuration' | 'definition.data.service_configuration.event_key' | 'definition.data.service_configuration.event_payload' | 'definition.data.service_configuration.report_id' | 'definition.data.service_configuration.service_method_type' | 'definition.data.service_configuration.tracking_company_id' | 'definition.data.status' | 'definition.data.target_days' | 'definition.data.target_time' | 'definition.data.timezone' | 'definition.data.trigger_filter' | 'definition.data.trigger_filter.condition_groups' | 'definition.data.trigger_id' | 'definition.data.trigger_subtype' | 'definition.data.trigger_type' | 'definition.data.unit' | 'definition.data.value' | 'definition.id' | 'definition.links' | 'definition.links.next' | 'definition.links.next_if_false' | 'definition.links.next_if_true' | 'definition.temporary_id' | 'definition.type' | 'updated'>; }): Promise<{ response: AxiosResponse; body: GetFlowActionEncodedResponse; }>; /** * Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message\'s flow action, given the flow ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Action ID for Flow Message * @param id */ getActionIdForFlowMessage(id: string): Promise<{ response: AxiosResponse; body: GetFlowMessageActionRelationshipResponse; }>; /** * Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Returns a maximum of 100 flows per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Action IDs for Flow * @param id * @param filter For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination* @param pageSize Default: 50. Min: 1. Max: 50.* @param sort For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting */ getActionIdsForFlow(id: string, options?: { filter?: string; pageCursor?: string; pageSize?: number; sort?: 'action_type' | '-action_type' | 'created' | '-created' | 'id' | '-id' | 'status' | '-status' | 'updated' | '-updated'; }): Promise<{ response: AxiosResponse; body: GetFlowFlowActionRelationshipListResponseCollection; }>; /** * Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Actions for Flow * @param id * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination* @param pageSize Default: 50. Min: 1. Max: 50.* @param sort For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting */ getActionsForFlow(id: string, options?: { fieldsFlowAction?: Array<'created' | 'definition' | 'definition.data' | 'definition.data.action_output_filter' | 'definition.data.action_output_filter.condition_groups' | 'definition.data.branches' | 'definition.data.current_experiment' | 'definition.data.current_experiment.allocations' | 'definition.data.current_experiment.automatic_winner_selection_settings' | 'definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date' | 'definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty' | 'definition.data.current_experiment.automatic_winner_selection_settings.enabled' | 'definition.data.current_experiment.id' | 'definition.data.current_experiment.name' | 'definition.data.current_experiment.started' | 'definition.data.current_experiment.variations' | 'definition.data.current_experiment.winner_metric' | 'definition.data.delay_until_time' | 'definition.data.delay_until_weekdays' | 'definition.data.experiment_status' | 'definition.data.list_id' | 'definition.data.main_action' | 'definition.data.main_action.data' | 'definition.data.main_action.data.message' | 'definition.data.main_action.data.message.action_buttons' | 'definition.data.main_action.data.message.add_info_link' | 'definition.data.main_action.data.message.add_opt_out_language' | 'definition.data.main_action.data.message.add_org_prefix' | 'definition.data.main_action.data.message.add_tracking_params' | 'definition.data.main_action.data.message.additional_filters' | 'definition.data.main_action.data.message.additional_filters.condition_groups' | 'definition.data.main_action.data.message.android_link' | 'definition.data.main_action.data.message.badge' | 'definition.data.main_action.data.message.badge_options' | 'definition.data.main_action.data.message.badge_options.badge_config' | 'definition.data.main_action.data.message.badge_options.set_from_property' | 'definition.data.main_action.data.message.badge_options.value' | 'definition.data.main_action.data.message.bcc_email' | 'definition.data.main_action.data.message.body' | 'definition.data.main_action.data.message.cc_email' | 'definition.data.main_action.data.message.conversion_metric_id' | 'definition.data.main_action.data.message.custom_tracking_params' | 'definition.data.main_action.data.message.dynamic_image' | 'definition.data.main_action.data.message.from_email' | 'definition.data.main_action.data.message.from_label' | 'definition.data.main_action.data.message.id' | 'definition.data.main_action.data.message.image_id' | 'definition.data.main_action.data.message.include_contact_card' | 'definition.data.main_action.data.message.ios_link' | 'definition.data.main_action.data.message.kv_pairs' | 'definition.data.main_action.data.message.name' | 'definition.data.main_action.data.message.on_open' | 'definition.data.main_action.data.message.preview_text' | 'definition.data.main_action.data.message.push_type' | 'definition.data.main_action.data.message.reply_to_email' | 'definition.data.main_action.data.message.shorten_links' | 'definition.data.main_action.data.message.smart_sending_enabled' | 'definition.data.main_action.data.message.sms_quiet_hours_enabled' | 'definition.data.main_action.data.message.sound' | 'definition.data.main_action.data.message.subject_line' | 'definition.data.main_action.data.message.template_id' | 'definition.data.main_action.data.message.title' | 'definition.data.main_action.data.message.transactional' | 'definition.data.main_action.data.message.video_asset_id' | 'definition.data.main_action.data.status' | 'definition.data.main_action.id' | 'definition.data.main_action.links' | 'definition.data.main_action.links.next' | 'definition.data.main_action.temporary_id' | 'definition.data.main_action.type' | 'definition.data.message' | 'definition.data.message.action_buttons' | 'definition.data.message.add_info_link' | 'definition.data.message.add_opt_out_language' | 'definition.data.message.add_org_prefix' | 'definition.data.message.add_tracking_params' | 'definition.data.message.additional_filters' | 'definition.data.message.additional_filters.condition_groups' | 'definition.data.message.android_link' | 'definition.data.message.badge' | 'definition.data.message.badge_options' | 'definition.data.message.badge_options.badge_config' | 'definition.data.message.badge_options.set_from_property' | 'definition.data.message.badge_options.value' | 'definition.data.message.bcc_email' | 'definition.data.message.body' | 'definition.data.message.cc_email' | 'definition.data.message.conversion_metric_id' | 'definition.data.message.custom_tracking_params' | 'definition.data.message.dynamic_image' | 'definition.data.message.from_email' | 'definition.data.message.from_label' | 'definition.data.message.headers' | 'definition.data.message.id' | 'definition.data.message.image_id' | 'definition.data.message.include_contact_card' | 'definition.data.message.ios_link' | 'definition.data.message.kv_pairs' | 'definition.data.message.name' | 'definition.data.message.on_open' | 'definition.data.message.preview_text' | 'definition.data.message.push_type' | 'definition.data.message.reply_to_email' | 'definition.data.message.shorten_links' | 'definition.data.message.smart_sending_enabled' | 'definition.data.message.sms_quiet_hours_enabled' | 'definition.data.message.sound' | 'definition.data.message.subject_line' | 'definition.data.message.template_id' | 'definition.data.message.title' | 'definition.data.message.to_emails' | 'definition.data.message.transactional' | 'definition.data.message.url' | 'definition.data.message.vendor_id' | 'definition.data.message.video_asset_id' | 'definition.data.name' | 'definition.data.on_execution' | 'definition.data.profile_filter' | 'definition.data.profile_filter.condition_groups' | 'definition.data.profile_operations' | 'definition.data.secondary_value' | 'definition.data.service_configuration' | 'definition.data.service_configuration.event_key' | 'definition.data.service_configuration.event_payload' | 'definition.data.service_configuration.report_id' | 'definition.data.service_configuration.service_method_type' | 'definition.data.service_configuration.tracking_company_id' | 'definition.data.status' | 'definition.data.target_days' | 'definition.data.target_time' | 'definition.data.timezone' | 'definition.data.trigger_filter' | 'definition.data.trigger_filter.condition_groups' | 'definition.data.trigger_id' | 'definition.data.trigger_subtype' | 'definition.data.trigger_type' | 'definition.data.unit' | 'definition.data.value' | 'definition.id' | 'definition.links' | 'definition.links.next' | 'definition.links.next_if_false' | 'definition.links.next_if_true' | 'definition.temporary_id' | 'definition.type' | 'updated'>; filter?: string; pageCursor?: string; pageSize?: number; sort?: 'action_type' | '-action_type' | 'created' | '-created' | 'id' | '-id' | 'status' | '-status' | 'updated' | '-updated'; }): Promise<{ response: AxiosResponse; body: GetFlowActionEncodedResponseCollection; }>; /** * Get a flow with the given flow ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow * @param id * @param additionalFieldsFlow Request additional fields not included by default in the response. Supported values: \'definition\'* @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param fieldsFlow For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships */ getFlow(id: string, options?: { additionalFieldsFlow?: Array<'definition'>; fieldsFlowAction?: Array<'created' | 'definition' | 'definition.data' | 'definition.data.action_output_filter' | 'definition.data.action_output_filter.condition_groups' | 'definition.data.branches' | 'definition.data.current_experiment' | 'definition.data.current_experiment.allocations' | 'definition.data.current_experiment.automatic_winner_selection_settings' | 'definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date' | 'definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty' | 'definition.data.current_experiment.automatic_winner_selection_settings.enabled' | 'definition.data.current_experiment.id' | 'definition.data.current_experiment.name' | 'definition.data.current_experiment.started' | 'definition.data.current_experiment.variations' | 'definition.data.current_experiment.winner_metric' | 'definition.data.delay_until_time' | 'definition.data.delay_until_weekdays' | 'definition.data.experiment_status' | 'definition.data.list_id' | 'definition.data.main_action' | 'definition.data.main_action.data' | 'definition.data.main_action.data.message' | 'definition.data.main_action.data.message.action_buttons' | 'definition.data.main_action.data.message.add_info_link' | 'definition.data.main_action.data.message.add_opt_out_language' | 'definition.data.main_action.data.message.add_org_prefix' | 'definition.data.main_action.data.message.add_tracking_params' | 'definition.data.main_action.data.message.additional_filters' | 'definition.data.main_action.data.message.additional_filters.condition_groups' | 'definition.data.main_action.data.message.android_link' | 'definition.data.main_action.data.message.badge' | 'definition.data.main_action.data.message.badge_options' | 'definition.data.main_action.data.message.badge_options.badge_config' | 'definition.data.main_action.data.message.badge_options.set_from_property' | 'definition.data.main_action.data.message.badge_options.value' | 'definition.data.main_action.data.message.bcc_email' | 'definition.data.main_action.data.message.body' | 'definition.data.main_action.data.message.cc_email' | 'definition.data.main_action.data.message.conversion_metric_id' | 'definition.data.main_action.data.message.custom_tracking_params' | 'definition.data.main_action.data.message.dynamic_image' | 'definition.data.main_action.data.message.from_email' | 'definition.data.main_action.data.message.from_label' | 'definition.data.main_action.data.message.id' | 'definition.data.main_action.data.message.image_id' | 'definition.data.main_action.data.message.include_contact_card' | 'definition.data.main_action.data.message.ios_link' | 'definition.data.main_action.data.message.kv_pairs' | 'definition.data.main_action.data.message.name' | 'definition.data.main_action.data.message.on_open' | 'definition.data.main_action.data.message.preview_text' | 'definition.data.main_action.data.message.push_type' | 'definition.data.main_action.data.message.reply_to_email' | 'definition.data.main_action.data.message.shorten_links' | 'definition.data.main_action.data.message.smart_sending_enabled' | 'definition.data.main_action.data.message.sms_quiet_hours_enabled' | 'definition.data.main_action.data.message.sound' | 'definition.data.main_action.data.message.subject_line' | 'definition.data.main_action.data.message.template_id' | 'definition.data.main_action.data.message.title' | 'definition.data.main_action.data.message.transactional' | 'definition.data.main_action.data.message.video_asset_id' | 'definition.data.main_action.data.status' | 'definition.data.main_action.id' | 'definition.data.main_action.links' | 'definition.data.main_action.links.next' | 'definition.data.main_action.temporary_id' | 'definition.data.main_action.type' | 'definition.data.message' | 'definition.data.message.action_buttons' | 'definition.data.message.add_info_link' | 'definition.data.message.add_opt_out_language' | 'definition.data.message.add_org_prefix' | 'definition.data.message.add_tracking_params' | 'definition.data.message.additional_filters' | 'definition.data.message.additional_filters.condition_groups' | 'definition.data.message.android_link' | 'definition.data.message.badge' | 'definition.data.message.badge_options' | 'definition.data.message.badge_options.badge_config' | 'definition.data.message.badge_options.set_from_property' | 'definition.data.message.badge_options.value' | 'definition.data.message.bcc_email' | 'definition.data.message.body' | 'definition.data.message.cc_email' | 'definition.data.message.conversion_metric_id' | 'definition.data.message.custom_tracking_params' | 'definition.data.message.dynamic_image' | 'definition.data.message.from_email' | 'definition.data.message.from_label' | 'definition.data.message.headers' | 'definition.data.message.id' | 'definition.data.message.image_id' | 'definition.data.message.include_contact_card' | 'definition.data.message.ios_link' | 'definition.data.message.kv_pairs' | 'definition.data.message.name' | 'definition.data.message.on_open' | 'definition.data.message.preview_text' | 'definition.data.message.push_type' | 'definition.data.message.reply_to_email' | 'definition.data.message.shorten_links' | 'definition.data.message.smart_sending_enabled' | 'definition.data.message.sms_quiet_hours_enabled' | 'definition.data.message.sound' | 'definition.data.message.subject_line' | 'definition.data.message.template_id' | 'definition.data.message.title' | 'definition.data.message.to_emails' | 'definition.data.message.transactional' | 'definition.data.message.url' | 'definition.data.message.vendor_id' | 'definition.data.message.video_asset_id' | 'definition.data.name' | 'definition.data.on_execution' | 'definition.data.profile_filter' | 'definition.data.profile_filter.condition_groups' | 'definition.data.profile_operations' | 'definition.data.secondary_value' | 'definition.data.service_configuration' | 'definition.data.service_configuration.event_key' | 'definition.data.service_configuration.event_payload' | 'definition.data.service_configuration.report_id' | 'definition.data.service_configuration.service_method_type' | 'definition.data.service_configuration.tracking_company_id' | 'definition.data.status' | 'definition.data.target_days' | 'definition.data.target_time' | 'definition.data.timezone' | 'definition.data.trigger_filter' | 'definition.data.trigger_filter.condition_groups' | 'definition.data.trigger_id' | 'definition.data.trigger_subtype' | 'definition.data.trigger_type' | 'definition.data.unit' | 'definition.data.value' | 'definition.id' | 'definition.links' | 'definition.links.next' | 'definition.links.next_if_false' | 'definition.links.next_if_true' | 'definition.temporary_id' | 'definition.type' | 'updated'>; fieldsFlow?: Array<'archived' | 'created' | 'definition' | 'definition.actions' | 'definition.entry_action_id' | 'definition.profile_filter' | 'definition.profile_filter.condition_groups' | 'definition.reentry_criteria' | 'definition.reentry_criteria.duration' | 'definition.reentry_criteria.unit' | 'definition.triggers' | 'name' | 'status' | 'trigger_type' | 'updated'>; fieldsTag?: Array<'name'>; include?: Array<'flow-actions' | 'tags'>; }): Promise<{ response: AxiosResponse; body: GetFlowV2ResponseCompoundDocument; }>; /** * Get a flow action from a flow with the given flow action ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow Action * @param id * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param fieldsFlowMessage For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param fieldsFlow For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships */ getFlowAction(id: string, options?: { fieldsFlowAction?: Array<'created' | 'definition' | 'definition.data' | 'definition.data.action_output_filter' | 'definition.data.action_output_filter.condition_groups' | 'definition.data.branches' | 'definition.data.current_experiment' | 'definition.data.current_experiment.allocations' | 'definition.data.current_experiment.automatic_winner_selection_settings' | 'definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date' | 'definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty' | 'definition.data.current_experiment.automatic_winner_selection_settings.enabled' | 'definition.data.current_experiment.id' | 'definition.data.current_experiment.name' | 'definition.data.current_experiment.started' | 'definition.data.current_experiment.variations' | 'definition.data.current_experiment.winner_metric' | 'definition.data.delay_until_time' | 'definition.data.delay_until_weekdays' | 'definition.data.experiment_status' | 'definition.data.list_id' | 'definition.data.main_action' | 'definition.data.main_action.data' | 'definition.data.main_action.data.message' | 'definition.data.main_action.data.message.action_buttons' | 'definition.data.main_action.data.message.add_info_link' | 'definition.data.main_action.data.message.add_opt_out_language' | 'definition.data.main_action.data.message.add_org_prefix' | 'definition.data.main_action.data.message.add_tracking_params' | 'definition.data.main_action.data.message.additional_filters' | 'definition.data.main_action.data.message.additional_filters.condition_groups' | 'definition.data.main_action.data.message.android_link' | 'definition.data.main_action.data.message.badge' | 'definition.data.main_action.data.message.badge_options' | 'definition.data.main_action.data.message.badge_options.badge_config' | 'definition.data.main_action.data.message.badge_options.set_from_property' | 'definition.data.main_action.data.message.badge_options.value' | 'definition.data.main_action.data.message.bcc_email' | 'definition.data.main_action.data.message.body' | 'definition.data.main_action.data.message.cc_email' | 'definition.data.main_action.data.message.conversion_metric_id' | 'definition.data.main_action.data.message.custom_tracking_params' | 'definition.data.main_action.data.message.dynamic_image' | 'definition.data.main_action.data.message.from_email' | 'definition.data.main_action.data.message.from_label' | 'definition.data.main_action.data.message.id' | 'definition.data.main_action.data.message.image_id' | 'definition.data.main_action.data.message.include_contact_card' | 'definition.data.main_action.data.message.ios_link' | 'definition.data.main_action.data.message.kv_pairs' | 'definition.data.main_action.data.message.name' | 'definition.data.main_action.data.message.on_open' | 'definition.data.main_action.data.message.preview_text' | 'definition.data.main_action.data.message.push_type' | 'definition.data.main_action.data.message.reply_to_email' | 'definition.data.main_action.data.message.shorten_links' | 'definition.data.main_action.data.message.smart_sending_enabled' | 'definition.data.main_action.data.message.sms_quiet_hours_enabled' | 'definition.data.main_action.data.message.sound' | 'definition.data.main_action.data.message.subject_line' | 'definition.data.main_action.data.message.template_id' | 'definition.data.main_action.data.message.title' | 'definition.data.main_action.data.message.transactional' | 'definition.data.main_action.data.message.video_asset_id' | 'definition.data.main_action.data.status' | 'definition.data.main_action.id' | 'definition.data.main_action.links' | 'definition.data.main_action.links.next' | 'definition.data.main_action.temporary_id' | 'definition.data.main_action.type' | 'definition.data.message' | 'definition.data.message.action_buttons' | 'definition.data.message.add_info_link' | 'definition.data.message.add_opt_out_language' | 'definition.data.message.add_org_prefix' | 'definition.data.message.add_tracking_params' | 'definition.data.message.additional_filters' | 'definition.data.message.additional_filters.condition_groups' | 'definition.data.message.android_link' | 'definition.data.message.badge' | 'definition.data.message.badge_options' | 'definition.data.message.badge_options.badge_config' | 'definition.data.message.badge_options.set_from_property' | 'definition.data.message.badge_options.value' | 'definition.data.message.bcc_email' | 'definition.data.message.body' | 'definition.data.message.cc_email' | 'definition.data.message.conversion_metric_id' | 'definition.data.message.custom_tracking_params' | 'definition.data.message.dynamic_image' | 'definition.data.message.from_email' | 'definition.data.message.from_label' | 'definition.data.message.headers' | 'definition.data.message.id' | 'definition.data.message.image_id' | 'definition.data.message.include_contact_card' | 'definition.data.message.ios_link' | 'definition.data.message.kv_pairs' | 'definition.data.message.name' | 'definition.data.message.on_open' | 'definition.data.message.preview_text' | 'definition.data.message.push_type' | 'definition.data.message.reply_to_email' | 'definition.data.message.shorten_links' | 'definition.data.message.smart_sending_enabled' | 'definition.data.message.sms_quiet_hours_enabled' | 'definition.data.message.sound' | 'definition.data.message.subject_line' | 'definition.data.message.template_id' | 'definition.data.message.title' | 'definition.data.message.to_emails' | 'definition.data.message.transactional' | 'definition.data.message.url' | 'definition.data.message.vendor_id' | 'definition.data.message.video_asset_id' | 'definition.data.name' | 'definition.data.on_execution' | 'definition.data.profile_filter' | 'definition.data.profile_filter.condition_groups' | 'definition.data.profile_operations' | 'definition.data.secondary_value' | 'definition.data.service_configuration' | 'definition.data.service_configuration.event_key' | 'definition.data.service_configuration.event_payload' | 'definition.data.service_configuration.report_id' | 'definition.data.service_configuration.service_method_type' | 'definition.data.service_configuration.tracking_company_id' | 'definition.data.status' | 'definition.data.target_days' | 'definition.data.target_time' | 'definition.data.timezone' | 'definition.data.trigger_filter' | 'definition.data.trigger_filter.condition_groups' | 'definition.data.trigger_id' | 'definition.data.trigger_subtype' | 'definition.data.trigger_type' | 'definition.data.unit' | 'definition.data.value' | 'definition.id' | 'definition.links' | 'definition.links.next' | 'definition.links.next_if_false' | 'definition.links.next_if_true' | 'definition.temporary_id' | 'definition.type' | 'updated'>; fieldsFlowMessage?: Array<'channel' | 'created' | 'definition' | 'definition.action_buttons' | 'definition.add_info_link' | 'definition.add_opt_out_language' | 'definition.add_org_prefix' | 'definition.add_tracking_params' | 'definition.additional_filters' | 'definition.additional_filters.condition_groups' | 'definition.android_link' | 'definition.badge' | 'definition.badge_options' | 'definition.badge_options.badge_config' | 'definition.badge_options.set_from_property' | 'definition.badge_options.value' | 'definition.bcc_email' | 'definition.body' | 'definition.cc_email' | 'definition.conversion_metric_id' | 'definition.custom_tracking_params' | 'definition.dynamic_image' | 'definition.from_email' | 'definition.from_label' | 'definition.headers' | 'definition.id' | 'definition.image_id' | 'definition.include_contact_card' | 'definition.ios_link' | 'definition.kv_pairs' | 'definition.name' | 'definition.on_open' | 'definition.preview_text' | 'definition.push_type' | 'definition.reply_to_email' | 'definition.shorten_links' | 'definition.smart_sending_enabled' | 'definition.sms_quiet_hours_enabled' | 'definition.sound' | 'definition.subject_line' | 'definition.template_id' | 'definition.title' | 'definition.to_emails' | 'definition.transactional' | 'definition.url' | 'definition.vendor_id' | 'definition.video_asset_id' | 'updated'>; fieldsFlow?: Array<'archived' | 'created' | 'name' | 'status' | 'trigger_type' | 'updated'>; include?: Array<'flow' | 'flow-messages'>; }): Promise<{ response: AxiosResponse; body: GetFlowActionEncodedResponseCompoundDocument; }>; /** * Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Messages For Flow Action * @param id * @param fieldsFlowMessage For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination* @param pageSize Default: 50. Min: 1. Max: 50.* @param sort For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting */ getFlowActionMessages(id: string, options?: { fieldsFlowMessage?: Array<'channel' | 'created' | 'definition' | 'definition.action_buttons' | 'definition.add_info_link' | 'definition.add_opt_out_language' | 'definition.add_org_prefix' | 'definition.add_tracking_params' | 'definition.additional_filters' | 'definition.additional_filters.condition_groups' | 'definition.android_link' | 'definition.badge' | 'definition.badge_options' | 'definition.badge_options.badge_config' | 'definition.badge_options.set_from_property' | 'definition.badge_options.value' | 'definition.bcc_email' | 'definition.body' | 'definition.cc_email' | 'definition.conversion_metric_id' | 'definition.custom_tracking_params' | 'definition.dynamic_image' | 'definition.from_email' | 'definition.from_label' | 'definition.headers' | 'definition.id' | 'definition.image_id' | 'definition.include_contact_card' | 'definition.ios_link' | 'definition.kv_pairs' | 'definition.name' | 'definition.on_open' | 'definition.preview_text' | 'definition.push_type' | 'definition.reply_to_email' | 'definition.shorten_links' | 'definition.smart_sending_enabled' | 'definition.sms_quiet_hours_enabled' | 'definition.sound' | 'definition.subject_line' | 'definition.template_id' | 'definition.title' | 'definition.to_emails' | 'definition.transactional' | 'definition.url' | 'definition.vendor_id' | 'definition.video_asset_id' | 'updated'>; filter?: string; pageCursor?: string; pageSize?: number; sort?: 'created' | '-created' | 'id' | '-id' | 'name' | '-name' | 'updated' | '-updated'; }): Promise<{ response: AxiosResponse; body: GetFlowMessageEncodedResponseCollection; }>; /** * Get the flow associated with the given action ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow for Flow Action * @param id * @param fieldsFlow For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets */ getFlowForFlowAction(id: string, options?: { fieldsFlow?: Array<'archived' | 'created' | 'name' | 'status' | 'trigger_type' | 'updated'>; }): Promise<{ response: AxiosResponse; body: GetFlowResponse; }>; /** * Get the flow associated with the given action ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow ID for Flow Action * @param id */ getFlowIdForFlowAction(id: string): Promise<{ response: AxiosResponse; body: GetFlowActionFlowRelationshipResponse; }>; /** * Get a flow message from a flow with the given flow message ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flow Message * @param id * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param fieldsFlowMessage For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships */ getFlowMessage(id: string, options?: { fieldsFlowAction?: Array<'created' | 'definition' | 'definition.data' | 'definition.data.action_output_filter' | 'definition.data.action_output_filter.condition_groups' | 'definition.data.branches' | 'definition.data.current_experiment' | 'definition.data.current_experiment.allocations' | 'definition.data.current_experiment.automatic_winner_selection_settings' | 'definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date' | 'definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty' | 'definition.data.current_experiment.automatic_winner_selection_settings.enabled' | 'definition.data.current_experiment.id' | 'definition.data.current_experiment.name' | 'definition.data.current_experiment.started' | 'definition.data.current_experiment.variations' | 'definition.data.current_experiment.winner_metric' | 'definition.data.delay_until_time' | 'definition.data.delay_until_weekdays' | 'definition.data.experiment_status' | 'definition.data.list_id' | 'definition.data.main_action' | 'definition.data.main_action.data' | 'definition.data.main_action.data.message' | 'definition.data.main_action.data.message.action_buttons' | 'definition.data.main_action.data.message.add_info_link' | 'definition.data.main_action.data.message.add_opt_out_language' | 'definition.data.main_action.data.message.add_org_prefix' | 'definition.data.main_action.data.message.add_tracking_params' | 'definition.data.main_action.data.message.additional_filters' | 'definition.data.main_action.data.message.additional_filters.condition_groups' | 'definition.data.main_action.data.message.android_link' | 'definition.data.main_action.data.message.badge' | 'definition.data.main_action.data.message.badge_options' | 'definition.data.main_action.data.message.badge_options.badge_config' | 'definition.data.main_action.data.message.badge_options.set_from_property' | 'definition.data.main_action.data.message.badge_options.value' | 'definition.data.main_action.data.message.bcc_email' | 'definition.data.main_action.data.message.body' | 'definition.data.main_action.data.message.cc_email' | 'definition.data.main_action.data.message.conversion_metric_id' | 'definition.data.main_action.data.message.custom_tracking_params' | 'definition.data.main_action.data.message.dynamic_image' | 'definition.data.main_action.data.message.from_email' | 'definition.data.main_action.data.message.from_label' | 'definition.data.main_action.data.message.id' | 'definition.data.main_action.data.message.image_id' | 'definition.data.main_action.data.message.include_contact_card' | 'definition.data.main_action.data.message.ios_link' | 'definition.data.main_action.data.message.kv_pairs' | 'definition.data.main_action.data.message.name' | 'definition.data.main_action.data.message.on_open' | 'definition.data.main_action.data.message.preview_text' | 'definition.data.main_action.data.message.push_type' | 'definition.data.main_action.data.message.reply_to_email' | 'definition.data.main_action.data.message.shorten_links' | 'definition.data.main_action.data.message.smart_sending_enabled' | 'definition.data.main_action.data.message.sms_quiet_hours_enabled' | 'definition.data.main_action.data.message.sound' | 'definition.data.main_action.data.message.subject_line' | 'definition.data.main_action.data.message.template_id' | 'definition.data.main_action.data.message.title' | 'definition.data.main_action.data.message.transactional' | 'definition.data.main_action.data.message.video_asset_id' | 'definition.data.main_action.data.status' | 'definition.data.main_action.id' | 'definition.data.main_action.links' | 'definition.data.main_action.links.next' | 'definition.data.main_action.temporary_id' | 'definition.data.main_action.type' | 'definition.data.message' | 'definition.data.message.action_buttons' | 'definition.data.message.add_info_link' | 'definition.data.message.add_opt_out_language' | 'definition.data.message.add_org_prefix' | 'definition.data.message.add_tracking_params' | 'definition.data.message.additional_filters' | 'definition.data.message.additional_filters.condition_groups' | 'definition.data.message.android_link' | 'definition.data.message.badge' | 'definition.data.message.badge_options' | 'definition.data.message.badge_options.badge_config' | 'definition.data.message.badge_options.set_from_property' | 'definition.data.message.badge_options.value' | 'definition.data.message.bcc_email' | 'definition.data.message.body' | 'definition.data.message.cc_email' | 'definition.data.message.conversion_metric_id' | 'definition.data.message.custom_tracking_params' | 'definition.data.message.dynamic_image' | 'definition.data.message.from_email' | 'definition.data.message.from_label' | 'definition.data.message.headers' | 'definition.data.message.id' | 'definition.data.message.image_id' | 'definition.data.message.include_contact_card' | 'definition.data.message.ios_link' | 'definition.data.message.kv_pairs' | 'definition.data.message.name' | 'definition.data.message.on_open' | 'definition.data.message.preview_text' | 'definition.data.message.push_type' | 'definition.data.message.reply_to_email' | 'definition.data.message.shorten_links' | 'definition.data.message.smart_sending_enabled' | 'definition.data.message.sms_quiet_hours_enabled' | 'definition.data.message.sound' | 'definition.data.message.subject_line' | 'definition.data.message.template_id' | 'definition.data.message.title' | 'definition.data.message.to_emails' | 'definition.data.message.transactional' | 'definition.data.message.url' | 'definition.data.message.vendor_id' | 'definition.data.message.video_asset_id' | 'definition.data.name' | 'definition.data.on_execution' | 'definition.data.profile_filter' | 'definition.data.profile_filter.condition_groups' | 'definition.data.profile_operations' | 'definition.data.secondary_value' | 'definition.data.service_configuration' | 'definition.data.service_configuration.event_key' | 'definition.data.service_configuration.event_payload' | 'definition.data.service_configuration.report_id' | 'definition.data.service_configuration.service_method_type' | 'definition.data.service_configuration.tracking_company_id' | 'definition.data.status' | 'definition.data.target_days' | 'definition.data.target_time' | 'definition.data.timezone' | 'definition.data.trigger_filter' | 'definition.data.trigger_filter.condition_groups' | 'definition.data.trigger_id' | 'definition.data.trigger_subtype' | 'definition.data.trigger_type' | 'definition.data.unit' | 'definition.data.value' | 'definition.id' | 'definition.links' | 'definition.links.next' | 'definition.links.next_if_false' | 'definition.links.next_if_true' | 'definition.temporary_id' | 'definition.type' | 'updated'>; fieldsFlowMessage?: Array<'channel' | 'created' | 'definition' | 'definition.action_buttons' | 'definition.add_info_link' | 'definition.add_opt_out_language' | 'definition.add_org_prefix' | 'definition.add_tracking_params' | 'definition.additional_filters' | 'definition.additional_filters.condition_groups' | 'definition.android_link' | 'definition.badge' | 'definition.badge_options' | 'definition.badge_options.badge_config' | 'definition.badge_options.set_from_property' | 'definition.badge_options.value' | 'definition.bcc_email' | 'definition.body' | 'definition.cc_email' | 'definition.conversion_metric_id' | 'definition.custom_tracking_params' | 'definition.dynamic_image' | 'definition.from_email' | 'definition.from_label' | 'definition.headers' | 'definition.id' | 'definition.image_id' | 'definition.include_contact_card' | 'definition.ios_link' | 'definition.kv_pairs' | 'definition.name' | 'definition.on_open' | 'definition.preview_text' | 'definition.push_type' | 'definition.reply_to_email' | 'definition.shorten_links' | 'definition.smart_sending_enabled' | 'definition.sms_quiet_hours_enabled' | 'definition.sound' | 'definition.subject_line' | 'definition.template_id' | 'definition.title' | 'definition.to_emails' | 'definition.transactional' | 'definition.url' | 'definition.vendor_id' | 'definition.video_asset_id' | 'updated'>; fieldsTemplate?: Array<'amp' | 'created' | 'editor_type' | 'html' | 'name' | 'text' | 'updated'>; include?: Array<'flow-action' | 'template'>; }): Promise<{ response: AxiosResponse; body: GetFlowMessageEncodedResponseCompoundDocument; }>; /** * Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Flows * @param fieldsFlowAction For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param fieldsFlow For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`* @param include For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination* @param pageSize Default: 50. Min: 1. Max: 50.* @param sort For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting */ getFlows(options?: { fieldsFlowAction?: Array<'created' | 'definition' | 'definition.data' | 'definition.data.action_output_filter' | 'definition.data.action_output_filter.condition_groups' | 'definition.data.branches' | 'definition.data.current_experiment' | 'definition.data.current_experiment.allocations' | 'definition.data.current_experiment.automatic_winner_selection_settings' | 'definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date' | 'definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty' | 'definition.data.current_experiment.automatic_winner_selection_settings.enabled' | 'definition.data.current_experiment.id' | 'definition.data.current_experiment.name' | 'definition.data.current_experiment.started' | 'definition.data.current_experiment.variations' | 'definition.data.current_experiment.winner_metric' | 'definition.data.delay_until_time' | 'definition.data.delay_until_weekdays' | 'definition.data.experiment_status' | 'definition.data.list_id' | 'definition.data.main_action' | 'definition.data.main_action.data' | 'definition.data.main_action.data.message' | 'definition.data.main_action.data.message.action_buttons' | 'definition.data.main_action.data.message.add_info_link' | 'definition.data.main_action.data.message.add_opt_out_language' | 'definition.data.main_action.data.message.add_org_prefix' | 'definition.data.main_action.data.message.add_tracking_params' | 'definition.data.main_action.data.message.additional_filters' | 'definition.data.main_action.data.message.additional_filters.condition_groups' | 'definition.data.main_action.data.message.android_link' | 'definition.data.main_action.data.message.badge' | 'definition.data.main_action.data.message.badge_options' | 'definition.data.main_action.data.message.badge_options.badge_config' | 'definition.data.main_action.data.message.badge_options.set_from_property' | 'definition.data.main_action.data.message.badge_options.value' | 'definition.data.main_action.data.message.bcc_email' | 'definition.data.main_action.data.message.body' | 'definition.data.main_action.data.message.cc_email' | 'definition.data.main_action.data.message.conversion_metric_id' | 'definition.data.main_action.data.message.custom_tracking_params' | 'definition.data.main_action.data.message.dynamic_image' | 'definition.data.main_action.data.message.from_email' | 'definition.data.main_action.data.message.from_label' | 'definition.data.main_action.data.message.id' | 'definition.data.main_action.data.message.image_id' | 'definition.data.main_action.data.message.include_contact_card' | 'definition.data.main_action.data.message.ios_link' | 'definition.data.main_action.data.message.kv_pairs' | 'definition.data.main_action.data.message.name' | 'definition.data.main_action.data.message.on_open' | 'definition.data.main_action.data.message.preview_text' | 'definition.data.main_action.data.message.push_type' | 'definition.data.main_action.data.message.reply_to_email' | 'definition.data.main_action.data.message.shorten_links' | 'definition.data.main_action.data.message.smart_sending_enabled' | 'definition.data.main_action.data.message.sms_quiet_hours_enabled' | 'definition.data.main_action.data.message.sound' | 'definition.data.main_action.data.message.subject_line' | 'definition.data.main_action.data.message.template_id' | 'definition.data.main_action.data.message.title' | 'definition.data.main_action.data.message.transactional' | 'definition.data.main_action.data.message.video_asset_id' | 'definition.data.main_action.data.status' | 'definition.data.main_action.id' | 'definition.data.main_action.links' | 'definition.data.main_action.links.next' | 'definition.data.main_action.temporary_id' | 'definition.data.main_action.type' | 'definition.data.message' | 'definition.data.message.action_buttons' | 'definition.data.message.add_info_link' | 'definition.data.message.add_opt_out_language' | 'definition.data.message.add_org_prefix' | 'definition.data.message.add_tracking_params' | 'definition.data.message.additional_filters' | 'definition.data.message.additional_filters.condition_groups' | 'definition.data.message.android_link' | 'definition.data.message.badge' | 'definition.data.message.badge_options' | 'definition.data.message.badge_options.badge_config' | 'definition.data.message.badge_options.set_from_property' | 'definition.data.message.badge_options.value' | 'definition.data.message.bcc_email' | 'definition.data.message.body' | 'definition.data.message.cc_email' | 'definition.data.message.conversion_metric_id' | 'definition.data.message.custom_tracking_params' | 'definition.data.message.dynamic_image' | 'definition.data.message.from_email' | 'definition.data.message.from_label' | 'definition.data.message.headers' | 'definition.data.message.id' | 'definition.data.message.image_id' | 'definition.data.message.include_contact_card' | 'definition.data.message.ios_link' | 'definition.data.message.kv_pairs' | 'definition.data.message.name' | 'definition.data.message.on_open' | 'definition.data.message.preview_text' | 'definition.data.message.push_type' | 'definition.data.message.reply_to_email' | 'definition.data.message.shorten_links' | 'definition.data.message.smart_sending_enabled' | 'definition.data.message.sms_quiet_hours_enabled' | 'definition.data.message.sound' | 'definition.data.message.subject_line' | 'definition.data.message.template_id' | 'definition.data.message.title' | 'definition.data.message.to_emails' | 'definition.data.message.transactional' | 'definition.data.message.url' | 'definition.data.message.vendor_id' | 'definition.data.message.video_asset_id' | 'definition.data.name' | 'definition.data.on_execution' | 'definition.data.profile_filter' | 'definition.data.profile_filter.condition_groups' | 'definition.data.profile_operations' | 'definition.data.secondary_value' | 'definition.data.service_configuration' | 'definition.data.service_configuration.event_key' | 'definition.data.service_configuration.event_payload' | 'definition.data.service_configuration.report_id' | 'definition.data.service_configuration.service_method_type' | 'definition.data.service_configuration.tracking_company_id' | 'definition.data.status' | 'definition.data.target_days' | 'definition.data.target_time' | 'definition.data.timezone' | 'definition.data.trigger_filter' | 'definition.data.trigger_filter.condition_groups' | 'definition.data.trigger_id' | 'definition.data.trigger_subtype' | 'definition.data.trigger_type' | 'definition.data.unit' | 'definition.data.value' | 'definition.id' | 'definition.links' | 'definition.links.next' | 'definition.links.next_if_false' | 'definition.links.next_if_true' | 'definition.temporary_id' | 'definition.type' | 'updated'>; fieldsFlow?: Array<'archived' | 'created' | 'name' | 'status' | 'trigger_type' | 'updated'>; fieldsTag?: Array<'name'>; filter?: string; include?: Array<'flow-actions' | 'tags'>; pageCursor?: string; pageSize?: number; sort?: 'created' | '-created' | 'id' | '-id' | 'name' | '-name' | 'status' | '-status' | 'trigger_type' | '-trigger_type' | 'updated' | '-updated'; }): Promise<{ response: AxiosResponse; body: GetFlowResponseCollectionCompoundDocument; }>; /** * Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` * @summary Get Message IDs for Flow Action * @param id * @param filter For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination* @param pageSize Default: 50. Min: 1. Max: 50.* @param sort For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting */ getMessageIdsForFlowAction(id: string, options?: { filter?: string; pageCursor?: string; pageSize?: number; sort?: 'created' | '-created' | 'id' | '-id' | 'name' | '-name' | 'updated' | '-updated'; }): Promise<{ response: AxiosResponse; body: GetFlowActionFlowMessageRelationshipResponseCollection; }>; /** * Return the tag IDs of all tags associated with the given flow.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` `tags:read` * @summary Get Tag IDs for Flow * @param id */ getTagIdsForFlow(id: string): Promise<{ response: AxiosResponse; body: GetFlowTagsRelationshipsResponseCollection; }>; /** * Return all tags associated with the given flow ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` `tags:read` * @summary Get Tags for Flow * @param id * @param fieldsTag For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets */ getTagsForFlow(id: string, options?: { fieldsTag?: Array<'name'>; }): Promise<{ response: AxiosResponse; body: GetTagResponseCollection; }>; /** * Return the related template

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `templates:read` * @summary Get Template for Flow Message * @param id * @param fieldsTemplate For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets */ getTemplateForFlowMessage(id: string, options?: { fieldsTemplate?: Array<'amp' | 'created' | 'editor_type' | 'html' | 'name' | 'text' | 'updated'>; }): Promise<{ response: AxiosResponse; body: GetTemplateResponse; }>; /** * Returns the ID of the related template

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `templates:read` * @summary Get Template ID for Flow Message * @param id */ getTemplateIdForFlowMessage(id: string): Promise<{ response: AxiosResponse; body: GetFlowMessageTemplateRelationshipResponse; }>; /** * Update the status of a flow with the given flow ID, and all actions in that flow.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:write` * @summary Update Flow Status * @param id ID of the Flow to update. Ex: XVTP5Q* @param flowUpdateQuery */ updateFlow(id: string, flowUpdateQuery: FlowUpdateQuery): Promise<{ response: AxiosResponse; body: PatchFlowResponse; }>; /** * Update a flow action.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:write` * @summary Update Flow Action * @param id * @param flowActionUpdateQuery */ updateFlowAction(id: string, flowActionUpdateQuery: FlowActionUpdateQuery): Promise<{ response: AxiosResponse; body: PatchFlowActionEncodedResponse; }>; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getActionForFlowMessage} * * @deprecated Use {@link FlowsApi.getActionForFlowMessage} instead */ getFlowMessageAction: typeof FlowsApi.prototype.getActionForFlowMessage; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getActionIdForFlowMessage} * * @deprecated Use {@link FlowsApi.getActionIdForFlowMessage} instead */ getFlowMessageRelationshipsAction: typeof FlowsApi.prototype.getActionIdForFlowMessage; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getActionIdsForFlow} * * @deprecated Use {@link FlowsApi.getActionIdsForFlow} instead */ getFlowRelationshipsFlowActions: typeof FlowsApi.prototype.getActionIdsForFlow; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getActionIdsForFlow} * * @deprecated Use {@link FlowsApi.getActionIdsForFlow} instead */ getFlowRelationshipsActions: typeof FlowsApi.prototype.getActionIdsForFlow; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getActionsForFlow} * * @deprecated Use {@link FlowsApi.getActionsForFlow} instead */ getFlowFlowActions: typeof FlowsApi.prototype.getActionsForFlow; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getActionsForFlow} * * @deprecated Use {@link FlowsApi.getActionsForFlow} instead */ getFlowActions: typeof FlowsApi.prototype.getActionsForFlow; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getFlowActionMessages} * * @deprecated Use {@link FlowsApi.getFlowActionMessages} instead */ getMessagesForFlowAction: typeof FlowsApi.prototype.getFlowActionMessages; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getFlowForFlowAction} * * @deprecated Use {@link FlowsApi.getFlowForFlowAction} instead */ getFlowActionFlow: typeof FlowsApi.prototype.getFlowForFlowAction; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getFlowIdForFlowAction} * * @deprecated Use {@link FlowsApi.getFlowIdForFlowAction} instead */ getFlowActionRelationshipsFlow: typeof FlowsApi.prototype.getFlowIdForFlowAction; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getMessageIdsForFlowAction} * * @deprecated Use {@link FlowsApi.getMessageIdsForFlowAction} instead */ getFlowActionRelationshipsMessages: typeof FlowsApi.prototype.getMessageIdsForFlowAction; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getTagIdsForFlow} * * @deprecated Use {@link FlowsApi.getTagIdsForFlow} instead */ getFlowRelationshipsTags: typeof FlowsApi.prototype.getTagIdsForFlow; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getTagsForFlow} * * @deprecated Use {@link FlowsApi.getTagsForFlow} instead */ getFlowTags: typeof FlowsApi.prototype.getTagsForFlow; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getTemplateForFlowMessage} * * @deprecated Use {@link FlowsApi.getTemplateForFlowMessage} instead */ getFlowMessageTemplate: typeof FlowsApi.prototype.getTemplateForFlowMessage; } export interface FlowsApi { /** * Alias of {@link FlowsApi.getTemplateIdForFlowMessage} * * @deprecated Use {@link FlowsApi.getTemplateIdForFlowMessage} instead */ getFlowMessageRelationshipsTemplate: typeof FlowsApi.prototype.getTemplateIdForFlowMessage; }