Klaviyo Flows API is one of 23 APIs that Klaviyo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Flows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, an API reference, authentication docs, and rate-limit docs.
This API exposes 20 operations across 16 paths, and defines 238 schemas. It is described by OpenAPI 3.0.2, at version 2026-04-15.
Requests are made against a single base URL, https://a.klaviyo.com.
20 operations
16 paths
238 schemas
1 DELETE16 GET2 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Klaviyo Flows API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (Klaviyo-API-Key).
By default, every request must be authenticated.
Klaviyo-API-Key— Private key authentication for /api/ endpoints is performed by setting the Authorization header to Klaviyo-API-Key your-private-api-key For more information pl…
Paths & Operations 20
Across 16 paths, the API surfaces 20 operations — 1 DELETE, 16 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Flows 20
flows
GET
/api/flows
Get Flows
POST
/api/flows
Create Flow
GET
/api/flows/{id}
Get Flow
PATCH
/api/flows/{id}
Update Flow Status
DELETE
/api/flows/{id}
Delete Flow
GET
/api/flow-actions/{id}
Get Flow Action
PATCH
/api/flow-actions/{id}
Update Flow Action
GET
/api/flow-messages/{id}
Get Flow Message
GET
/api/flows/{id}/flow-actions
Get Actions for Flow
GET
/api/flows/{id}/relationships/flow-actions
Get Action IDs for Flow
GET
/api/flows/{id}/tags
Get Tags for Flow
GET
/api/flows/{id}/relationships/tags
Get Tag IDs for Flow
GET
/api/flow-actions/{id}/flow
Get Flow for Flow Action
GET
/api/flow-actions/{id}/relationships/flow
Get Flow ID for Flow Action
GET
/api/flow-actions/{id}/flow-messages
Get Messages For Flow Action
GET
/api/flow-actions/{id}/relationships/flow-messages
Get Message IDs for Flow Action
GET
/api/flow-messages/{id}/flow-action
Get Action for Flow Message
GET
/api/flow-messages/{id}/relationships/flow-action
Get Action ID for Flow Message
GET
/api/flow-messages/{id}/template
Get Template for Flow Message
GET
/api/flow-messages/{id}/relationships/template
Get Template ID for Flow Message
Schemas 238
The contract defines 238 schemas that model the data the API accepts and returns. The most detailed are FlowPushNotification (19 properties), FlowSms (17 properties), FlowEmail (15 properties), ProfilePropertyDateTrigger (9 properties). Each schema is shown below with its type and property counts.
MessageBlockedMethodFilter
object
2 properties
2 required
ConstantContactIntegrationFilter
object
3 properties
3 required
NoEmailMarketingNeverSubscribed
object
2 properties
2 required
InternalScheduledReportData
object
2 properties
2 required
ContentExperimentAction
object
5 properties
2 required
ProfilePropertyDateTrigger
object
9 properties
5 required
PriceDropConditionConditionGroup
object
1 property
1 required
PushActionButton
object
5 properties
2 required
GetFlowFlowActionRelationshipListResponseCollection
object
2 properties
1 required
FlowActionUpdateQuery
object
1 property
1 required
GetTagResponseCollection
object
2 properties
1 required
ListEnum
string
LowInventoryConditionConditionGroup
object
1 property
1 required
StatusDateFilter
object
2 properties
2 required
TimeDelayActionData
object
6 properties
1 required
CustomObjectTriggerCondition
object
3 properties
3 required
GetFlowResponse
object
2 properties
1 required
FlowV2ResponseObjectResource
object
5 properties
4 required
MultiBranchSplitBranch
object
6 properties
1 required
GetFlowActionFlowMessageRelationshipResponseCollection
object
2 properties
1 required
HasPushMarketingConsent
object
3 properties
3 required
FlowPushNotification
object
19 properties
1 required
CodeAction
object
5 properties
1 required
GetFlowTagsRelationshipsResponseCollection
object
2 properties
1 required
ProfileModificationMethodFilter
object
2 properties
2 required
LowInventoryTrigger
object
6 properties
5 required
ReentryCriteria
object
2 properties
2 required
FlowWebhook
object
5 properties
1 required
CheckoutMethodFilter
object
2 properties
2 required
FlowMessageEnum
string
ActionOutputConditionConditionGroup
object
1 property
1 required
GetFlowMessageEncodedResponseCollection
object
2 properties
1 required
RelativeAnniversaryDateFilter
object
4 properties
4 required
TargetDateAction
object
5 properties
2 required
ConditionalBranchAction
object
5 properties
1 required
ProfilePredictiveAnalyticsStringFilter
object
3 properties
3 required
ShopifyIntegrationFilter
object
3 properties
3 required
DoubleOptinFilter
object
2 properties
2 required
ObjectLinks
object
1 property
1 required
ExplicitlyUnreachable
object
2 properties
2 required
ProfileMarketingConsentCondition
object
2 properties
2 required
PreferencePageFilter
object
3 properties
2 required
NoSMSMarketingUnsubscribed
object
2 properties
1 required
Increment
object
1 property
1 required
FlowEmail
object
15 properties
7 required
ConditionalBranchActionData
object
1 property
1 required
MethodFilter
object
2 properties
2 required
MultiBranchSplitAction
object
5 properties
1 required
TagEnum
string
FailedAgeGateMethodFilter
object
2 properties
2 required
ProfileHasCustomObjectFilter
object
2 properties
2 required
ListUpdateActionData
object
4 properties
3 required
ConstantContactIntegrationMethodFilter
object
3 properties
3 required
ProfileOperationUpdateOrCreateDate
object
4 properties
4 required
HasEmailMarketingNeverSubscribed
object
2 properties
1 required
ListUpdateAction
object
5 properties
2 required
AbTestAction
object
5 properties
2 required
NumericRangeFilter
object
4 properties
4 required
FormSubscribeFilter
object
3 properties
2 required
NoSMSMarketingConsent
object
3 properties
3 required
ProvidedNoAgeMethodFilter
object
2 properties
2 required
TriggerBranchActionData
object
4 properties
3 required
UtmParam
object
2 properties
2 required
UpdateProfileActionData
object
2 properties
1 required
ProfileOperationDelete
object
2 properties
2 required
SubscribedSMSIsRcsCapableFilter
object
2 properties
2 required
SendSmsAction
object
5 properties
1 required
GetFlowMessageEncodedResponseCompoundDocument
object
3 properties
1 required
AutomaticWinnerSelectionSettings
object
3 properties
2 required
APIMethodFilter
object
3 properties
2 required
StaticDateFilter
object
3 properties
3 required
ExplicitlyReachable
object
2 properties
2 required
ListLengthFilter
object
3 properties
3 required
RecordedDateFilter
object
2 properties
2 required
SftpMethodFilter
object
2 properties
2 required
InvalidEmailDateFilter
object
2 properties
2 required
CountdownDelayActionData
object
5 properties
CarrierDeactivationMethodFilter
object
2 properties
2 required
PatchFlowActionEncodedResponse
object
2 properties
1 required
HasPushMarketing
object
2 properties
1 required
SendWebhookActionData
object
2 properties
1 required
ImplicitlyReachable
object
1 property
1 required
TriggerBranchAction
object
5 properties
1 required
PriceDropCondition
object
4 properties
4 required
EffectiveDateFilter
object
2 properties
2 required
InternalServiceActionData
object
2 properties
SendInternalAlertActionData
object
2 properties
1 required
GetFlowMessageTemplateRelationshipResponse
object
2 properties
1 required
SpamComplaintMethodFilter
object
2 properties
2 required
GetFlowV2ResponseCompoundDocument
object
3 properties
1 required
GetTemplateResponse
object
2 properties
1 required
FlowEnum
string
CampaignEnum
string
FlowActionEncodedResponseObjectResource
object
5 properties
4 required
DataWarehouseImportMethodFilter
object
2 properties
2 required
Property
object
2 properties
2 required
EqualsStringFilter
object
3 properties
3 required
BooleanFilter
object
3 properties
3 required
ManualImportMethodFilter
object
2 properties
2 required
ProfileHasNotReceivedPushMessageCondition
object
2 properties
2 required
SendPushNotificationAction
object
5 properties
1 required
GetFlowActionEncodedResponseCollection
object
2 properties
1 required
ProfileHasCustomObjectCondition
object
5 properties
5 required
FlowActionEnum
string
ImplicitlyUnreachable
object
1 property
1 required
ProfileHasNotReceivedEmailMessageCondition
object
2 properties
2 required
ProfileOperationUpdateOrCreateList
object
5 properties
4 required
ProfilePropertyCondition
object
3 properties
3 required
NoEmailMarketingUnsubscribed
object
2 properties
1 required
SendWebhookAction
object
5 properties
1 required
RelationshipLinks
object
2 properties
2 required
BooleanBranchLinks
object
2 properties
2 required
BounceDateFilter
object
2 properties
2 required
NoEmailMarketing
object
2 properties
1 required
ProfileHasNotReceivedSmsMessageCondition
object
2 properties
2 required
BackInStockDelayAction
object
4 properties
1 required
UpdateProfileAction
object
5 properties
1 required
ImplicitlyOrExplicitlyUnreachable
object
1 property
1 required
ActionOutputSplitActionData
object
1 property
1 required
NoPushMarketingConsent
object
3 properties
3 required
CustomObjectPropertyCondition
object
4 properties
4 required
SendEmailAction
object
5 properties
1 required
StaticDateRangeFilter
object
4 properties
4 required
ProfileHasGroupMembershipCondition
object
4 properties
3 required
FlowResponseObjectResource
object
5 properties
4 required
FlowMessageEncodedResponseObjectResource
object
5 properties
4 required
Link
object
1 property
1 required
FlowUpdateQueryResourceObject
object
3 properties
3 required
ProfileOperationUpdateOrCreateString
object
4 properties
4 required
ImplicitlyOrExplicitlyReachable
object
1 property
1 required
SendWhatsAppActionData
object
2 properties
MetricPropertyConditionConditionGroup
object
1 property
1 required
PriceDropTrigger
object
7 properties
4 required
CountdownDelayAction
object
5 properties
2 required
InternalUnknownServiceData
object
1 property
1 required
FlowDefinition
object
5 properties
3 required
AlltimeDateFilter
object
2 properties
2 required
ProfileRegionCondition
object
3 properties
3 required
FlowUpdateQuery
object
1 property
1 required
LessThanPositiveNumericFilter
object
3 properties
3 required
CustomSourceFilter
object
2 properties
2 required
FlowActionUpdateQueryResourceObject
object
3 properties
3 required
FlowSms
object
17 properties
1 required
TagResponseObjectResource
object
5 properties
4 required
HasEmailMarketing
object
2 properties
1 required
NoSMSMarketing
object
1 property
1 required
OneClickUnsubscribeMethodFilter
object
2 properties
2 required
InTheLastBaseRelativeDateFilter
object
4 properties
4 required
ProfileNoGroupMembershipCondition
object
3 properties
3 required
MetricTrigger
object
3 properties
1 required
PostFlowV2Response
object
2 properties
1 required
TimeDelayAction
object
5 properties
2 required
ProvidedLandlineMethodFilter
object
2 properties
2 required
FlowWhatsApp
object
7 properties
InternalScheduledReportBuilderReportData
object
2 properties
2 required
ProfileOperationUpdateOrCreateBoolean
object
4 properties
4 required
ManualRemoveMethodFilter
object
2 properties
2 required
SegmentEnum
string
GetFlowActionEncodedResponseCompoundDocument
object
3 properties
1 required
NoEmailMarketingSubscribed
object
2 properties
2 required
ListSubstringFilter
object
3 properties
3 required
FormMethodFilter
object
3 properties
2 required
SendWhatsAppAction
object
5 properties
1 required
TagGroupEnum
string
GetFlowResponseCollectionCompoundDocument
object
3 properties
1 required
InboundMessageMethodFilter
object
2 properties
2 required
ProfilePredictiveAnalyticsDateCondition
object
3 properties
3 required
IntegerFilter
object
3 properties
3 required
NoEmailMarketingConsent
object
3 properties
3 required
SendPushNotificationActionData
object
2 properties
ManualImportManualMethodFilter
object
3 properties
2 required
ProfilePermissionsCondition
object
3 properties
3 required
ActionOutputCondition
object
4 properties
4 required
PriceDropConditionFilter
object
1 property
1 required
ManualAddManualMethodFilter
object
3 properties
2 required
StringPhoneOperatorStringArrayFilter
object
3 properties
3 required
IsSetExistenceFilter
object
2 properties
2 required
CalendarDateFilter
object
3 properties
3 required
NoPushMarketing
object
1 property
1 required
PreferencePageMethodFilter
object
2 properties
2 required
SendInternalAlertAction
object
5 properties
1 required
BulkRemoveMethodFilter
object
2 properties
2 required
ProfilePostalCodeDistanceCondition
object
5 properties
5 required
HasSMSMarketingSubscribed
object
2 properties
1 required
ActionOutputSplitAction
object
5 properties
1 required
ProfilePredictiveAnalyticsStringCondition
object
3 properties
3 required
ActionOutputConditionFilter
object
1 property
1 required
RelativeDateOperatorBaseRelativeDateFilter
object
4 properties
4 required
ExistenceOperatorExistenceFilter
object
2 properties
2 required
BackInStockMethodFilter
object
2 properties
2 required
StaticCount
object
2 properties
2 required
ProfileOperationUpdateOrCreateNumeric
object
4 properties
4 required
MetricPropertyConditionFilter
object
1 property
1 required
ListContainsOperatorListContainsFilter
object
3 properties
3 required
SendSmsActionData
object
2 properties
FlowCreateQueryResourceObject
object
2 properties
2 required
InternalServiceAction
object
5 properties
1 required
GetFlowActionEncodedResponse
object
2 properties
1 required
FlowsProfileMetricCondition
object
6 properties
5 required
ProfilePredictiveAnalyticsNumericCondition
object
3 properties
3 required
SinceFlowStartDateFilter
object
2 properties
2 required
LowInventoryCondition
object
4 properties
4 required
TemplateEnum
string
ListTrigger
object
2 properties
1 required
StringOperatorStringFilter
object
3 properties
3 required
ManualSuppressionDateFilter
object
2 properties
2 required
SegmentTrigger
object
2 properties
1 required
ShopifyIntegrationMethodFilter
object
3 properties
3 required
SendPushNotificationActionContentExperimentActionData
object
4 properties
1 required
GetFlowMessageActionRelationshipResponse
object
2 properties
1 required
RelativeDateRangeFilter
object
5 properties
5 required
HasEmailMarketingSubscribed
object
2 properties
1 required
MetricPropertyCondition
object
4 properties
4 required
MailboxProviderMethodFilter
object
2 properties
2 required
AnniversaryDateFilter
object
2 properties
2 required
ListSetFilter
object
3 properties
3 required
SendEmailActionData
object
2 properties
MultiBranchSplitActionData
object
2 properties
2 required
ProfileMetricPropertyFilter
object
2 properties
1 required
SendPushNotificationActionCurrentExperiment
object
6 properties
1 required
LowInventoryConditionFilter
object
1 property
1 required
InStringArrayFilter
object
3 properties
3 required
NoSMSMarketingNeverSubscribed
object
1 property
1 required
ProfileRandomSampleCondition
object
2 properties
2 required
GetFlowActionFlowRelationshipResponse
object
2 properties
1 required
GreaterThanPositiveNumericFilter
object
3 properties
3 required
FlowInternalAlert
object
7 properties
4 required
FlowCreateQuery
object
1 property
1 required
ProfileNotInFlowCondition
object
2 properties
2 required
NumericOperatorNumericFilter
object
3 properties
3 required
CollectionLinks
object
5 properties
1 required
HasSMSMarketingConsent
object
3 properties
3 required
PatchFlowResponse
object
2 properties
1 required
TargetDateActionData
object
3 properties
InternalTrackEventData
object
4 properties
1 required
StringArrayOperatorStringArrayFilter
object
3 properties
3 required
HasEmailMarketingConsent
object
3 properties
3 required
TemplateResponseObjectResource
object
4 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Klaviyo 12
Other APIs Klaviyo publishes across the network.
Klaviyo Accounts API
Klaviyo Campaigns API
Klaviyo Catalogs API
Klaviyo Client API
Klaviyo Conversations API
Klaviyo Coupons API
Klaviyo Custom Objects API
Klaviyo Data Privacy API
Klaviyo Events API
Klaviyo Forms API
Klaviyo Images API
Klaviyo Lists API
#Flows