List an action's messages
https://email.growthdept.ai/api/flow-actions/{id}/flow-messagesSort by created, id, name, updated, ascending or descending (put - in front).
Rate limits
Scopes
flows:read
Operation id
get_flow_action_messages The same operation as in Klaviyo's API. OpenAPI document
Path parameters
stringrequired
Query parameters
Pick values to add them to the request:
Fields and the operators each one takes:
- id: any
- name: contains, ends-with, equals, starts-with
- created: equals, greater-or-equal, greater-than, less-or-equal, less-than
- updated: equals, greater-or-equal, greater-than, less-or-equal, less-than
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
200Success
Response body
object
dataarray of objectsrequired
data: 5 fields
typestringrequired
flow-messageidstringrequired
attributesobjectrequired
attributes: 4 fields
channelstringcan be null
createdstring (date-time)can be null
updatedstring (date-time)can be null
definitionone ofcan be null
One option: FlowEmail
from_emailstringcan be null
from_labelstringcan be null
reply_to_emailstringcan be null
cc_emailstringcan be null
bcc_emailstringcan be null
subject_linestringcan be null
preview_textstringcan be null
template_idstringcan be null
smart_sending_enabledboolean
transactionalboolean
add_tracking_paramsboolean
custom_tracking_paramsarray of objectscan be null
custom_tracking_params: 2 fields
paramstringrequired
valuestringrequired
additional_filtersobjectcan be null
additional_filters: 1 field
condition_groupsarray of objectsrequired
condition_groups: 1 field
conditionsarray of objectsrequired
One option: ProfilePropertyCondition
typestringrequired
profile-propertypropertystringrequired
filterobjectrequired
One option: ProfileHasGroupMembershipCondition
typestringrequired
profile-group-membershipis_memberbooleanrequired
truegroup_idsarray of stringsrequired
timeframe_filterobjectcan be null
One option: ProfileNoGroupMembershipCondition
typestringrequired
profile-group-membershipis_memberbooleanrequired
falsegroup_idsarray of stringsrequired
One option: ProfileRegionCondition
typestringrequired
profile-regionin_regionbooleanrequired
regionstringrequired
european_unionunited_states
One option: ProfilePostalCodeDistanceCondition
typestringrequired
profile-postal-code-distancecountry_codestringrequired
postal_codestringrequired
unitstringrequired
kilometersmilesfilterobjectrequired
One option: ProfilePredictiveAnalyticsDateCondition
dimensionstringrequired
expected_date_of_next_purchasefilterobjectrequired
typestringrequired
profile-predictive-analytics
One option: ProfilePredictiveAnalyticsStringCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
predicted_genderfilterobjectrequired
One option: ProfilePredictiveAnalyticsNumericCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
average_days_between_ordersaverage_order_valuechurn_probabilityhistoric_clvhistoric_number_of_orderspredicted_clvpredicted_number_of_orderstotal_clvfilterobjectrequired
One option: ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
channel_affinitymeasurementstringrequired
prioritypredicted_channelstringrequired
emailpushsmswhatsappfilterobjectrequired
One option: ProfilePredictiveAnalyticsChannelAffinityRankCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
channel_affinitymeasurementstringrequired
rankpredicted_channelstringrequired
emailpushsmswhatsappfilterobjectrequired
One option: ProfileMarketingConsentCondition
typestringrequired
profile-marketing-consentconsentobjectrequired
One option: FlowsProfileMetricCondition
typestringrequired
profile-metricmetric_idstringrequired
measurementstringrequired
countsummeasurement_filterobjectrequired
timeframe_filterobjectrequired
metric_filtersarray of objectscan be null
One option: ProfileRandomSampleCondition
typestringrequired
profile-samplepercentageintegerrequired
One option: ProfileHasCustomObjectCondition
typestringrequired
profile-has-custom-objectobject_type_idstringrequired
object_type_relationship_idstringrequired
filterobjectrequired
filtersarray of objectsrequired
One option: ProfilePermissionsCondition
typestringrequired
profile-permissionspermissionobjectrequired
channelstringrequired
email_click_trackingemail_open_trackingwhatsapp_marketingwhatsapp_transactional
One option: ProfileHasNotReceivedEmailMessageCondition
typestringrequired
profile-not-sent-emailtimeframe_filterobjectrequired
One option: ProfileHasNotReceivedSmsMessageCondition
typestringrequired
profile-not-sent-smstimeframe_filterobjectrequired
One option: ProfileHasNotReceivedPushMessageCondition
typestringrequired
profile-not-sent-pushtimeframe_filterobjectrequired
namestringcan be null
idstringcan be null
One option: FlowInternalAlert
from_emailstringrequiredcan be null
from_labelstringrequiredcan be null
to_emailsarray of stringsrequired
subject_linestringrequiredcan be null
template_idstringcan be null
namestringcan be null
idstringcan be null
One option: FlowPushNotification
titlestringcan be null
bodystringrequired
soundboolean
badgeboolean
badge_optionsone of
One option: Increment
badge_configstringrequired
increment_one
One option: StaticCount
badge_configstringrequired
set_countvaluestringrequired
One option: Property
badge_configstringrequired
set_propertyset_from_propertystringrequired
image_idstringcan be null
dynamic_imagestringcan be null
video_asset_idstringcan be null
on_openstring
homelinkopen_urlios_linkstringcan be null
android_linkstringcan be null
web_urlstringcan be null
push_typestringcan be null
silentstandardkv_pairsobjectcan be null
conversion_metric_idstringcan be null
smart_sending_enabledboolean
additional_filtersobjectcan be null
additional_filters: 1 field
condition_groupsarray of objectsrequired
condition_groups: 1 field
conditionsarray of objectsrequired
One option: ProfilePropertyCondition
typestringrequired
profile-propertypropertystringrequired
filterobjectrequired
One option: ProfileHasGroupMembershipCondition
typestringrequired
profile-group-membershipis_memberbooleanrequired
truegroup_idsarray of stringsrequired
timeframe_filterobjectcan be null
One option: ProfileNoGroupMembershipCondition
typestringrequired
profile-group-membershipis_memberbooleanrequired
falsegroup_idsarray of stringsrequired
One option: ProfileRegionCondition
typestringrequired
profile-regionin_regionbooleanrequired
regionstringrequired
european_unionunited_states
One option: ProfilePostalCodeDistanceCondition
typestringrequired
profile-postal-code-distancecountry_codestringrequired
postal_codestringrequired
unitstringrequired
kilometersmilesfilterobjectrequired
One option: ProfilePredictiveAnalyticsDateCondition
dimensionstringrequired
expected_date_of_next_purchasefilterobjectrequired
typestringrequired
profile-predictive-analytics
One option: ProfilePredictiveAnalyticsStringCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
predicted_genderfilterobjectrequired
One option: ProfilePredictiveAnalyticsNumericCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
average_days_between_ordersaverage_order_valuechurn_probabilityhistoric_clvhistoric_number_of_orderspredicted_clvpredicted_number_of_orderstotal_clvfilterobjectrequired
One option: ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
channel_affinitymeasurementstringrequired
prioritypredicted_channelstringrequired
emailpushsmswhatsappfilterobjectrequired
One option: ProfilePredictiveAnalyticsChannelAffinityRankCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
channel_affinitymeasurementstringrequired
rankpredicted_channelstringrequired
emailpushsmswhatsappfilterobjectrequired
One option: ProfileMarketingConsentCondition
typestringrequired
profile-marketing-consentconsentobjectrequired
One option: FlowsProfileMetricCondition
typestringrequired
profile-metricmetric_idstringrequired
measurementstringrequired
countsummeasurement_filterobjectrequired
timeframe_filterobjectrequired
metric_filtersarray of objectscan be null
One option: ProfileRandomSampleCondition
typestringrequired
profile-samplepercentageintegerrequired
One option: ProfileHasCustomObjectCondition
typestringrequired
profile-has-custom-objectobject_type_idstringrequired
object_type_relationship_idstringrequired
filterobjectrequired
filtersarray of objectsrequired
One option: ProfilePermissionsCondition
typestringrequired
profile-permissionspermissionobjectrequired
channelstringrequired
email_click_trackingemail_open_trackingwhatsapp_marketingwhatsapp_transactional
One option: ProfileHasNotReceivedEmailMessageCondition
typestringrequired
profile-not-sent-emailtimeframe_filterobjectrequired
One option: ProfileHasNotReceivedSmsMessageCondition
typestringrequired
profile-not-sent-smstimeframe_filterobjectrequired
One option: ProfileHasNotReceivedPushMessageCondition
typestringrequired
profile-not-sent-pushtimeframe_filterobjectrequired
action_buttonsarray of objectscan be null
action_buttons: 8 fields
labelstringrequired
action_typestringrequired
deep_linkdismissopen_appopen_urlpositionintegercan be null
urlstringcan be null
iconstringcan be null
custom_action_idstringcan be null
ios_deep_linkstringcan be null
android_deep_linkstringcan be null
namestringcan be null
idstringcan be null
One option: FlowSms
bodystringrequired
image_idstringcan be null
dynamic_imagestringcan be null
message_hierarchyarray of objectscan be null
One option: MessageHierarchyRcsItem
messagestring
message_formatstring
RCSrich_contentobjectcan be null
rich_content: 3 fields
cardsarray of objectscan be null
cards: 7 fields
idstringrequired
titlestringcan be null
textstringcan be null
extraobjectcan be null
imageobjectcan be null
videoobjectcan be null
buttonsarray of objectscan be null
suggestionsarray of objectscan be null
suggestions: 5 fields
idstringrequired
textstringrequired
typestringrequired
OPEN_URLREPLYurlstringcan be null
open_modestringcan be null
BROWSERWEBVIEW_FULLWEBVIEW_HALFWEBVIEW_TALL
fileobjectcan be null
file: 3 fields
static_asset_idstringcan be null
dynamic_templatestringcan be null
thumbnailobjectcan be null
extraobjectcan be null
imageobjectcan be null
image: 3 fields
static_image_asset_idintegercan be null
dynamic_image_templatestringcan be null
rendered_asset_urlstringcan be null
One option: MessageHierarchySmsItem
messagestringrequired
message_formatstring
SMSextraobjectcan be null
imageone ofcan be null
One option: StaticSMSImage
dynamicbooleancan be null
falsestatic_image_asset_idintegerrequired
One option: DynamicSMSImage
dynamicboolean
truedynamic_image_templatestringrequired
mediaone ofcan be null
One option: MediaAsset
idstringrequired
company_idstringrequired
urlstringrequired
media_typestring
namestringrequired
file_sizeintegerrequired
thumbnail_urlstringcan be null
l10n_keystringcan be null
One option: MediaAssetReference
static_asset_idstringcan be null
dynamic_templatestringcan be null
thumbnailobjectcan be null
thumbnail: 3 fields
static_image_asset_idintegercan be null
dynamic_image_templatestringcan be null
rendered_asset_urlstringcan be null
shorten_linksboolean
include_contact_cardboolean
add_org_prefixboolean
add_info_linkboolean
add_opt_out_languageboolean
smart_sending_enabledboolean
sms_quiet_hours_enabledboolean
transactionalboolean
add_tracking_paramsboolean
custom_tracking_paramsarray of objectscan be null
custom_tracking_params: 2 fields
paramstringrequired
valuestringrequired
template_idstringcan be null
additional_filtersobjectcan be null
additional_filters: 1 field
condition_groupsarray of objectsrequired
condition_groups: 1 field
conditionsarray of objectsrequired
One option: ProfilePropertyCondition
typestringrequired
profile-propertypropertystringrequired
filterobjectrequired
One option: ProfileHasGroupMembershipCondition
typestringrequired
profile-group-membershipis_memberbooleanrequired
truegroup_idsarray of stringsrequired
timeframe_filterobjectcan be null
One option: ProfileNoGroupMembershipCondition
typestringrequired
profile-group-membershipis_memberbooleanrequired
falsegroup_idsarray of stringsrequired
One option: ProfileRegionCondition
typestringrequired
profile-regionin_regionbooleanrequired
regionstringrequired
european_unionunited_states
One option: ProfilePostalCodeDistanceCondition
typestringrequired
profile-postal-code-distancecountry_codestringrequired
postal_codestringrequired
unitstringrequired
kilometersmilesfilterobjectrequired
One option: ProfilePredictiveAnalyticsDateCondition
dimensionstringrequired
expected_date_of_next_purchasefilterobjectrequired
typestringrequired
profile-predictive-analytics
One option: ProfilePredictiveAnalyticsStringCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
predicted_genderfilterobjectrequired
One option: ProfilePredictiveAnalyticsNumericCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
average_days_between_ordersaverage_order_valuechurn_probabilityhistoric_clvhistoric_number_of_orderspredicted_clvpredicted_number_of_orderstotal_clvfilterobjectrequired
One option: ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
channel_affinitymeasurementstringrequired
prioritypredicted_channelstringrequired
emailpushsmswhatsappfilterobjectrequired
One option: ProfilePredictiveAnalyticsChannelAffinityRankCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
channel_affinitymeasurementstringrequired
rankpredicted_channelstringrequired
emailpushsmswhatsappfilterobjectrequired
One option: ProfileMarketingConsentCondition
typestringrequired
profile-marketing-consentconsentobjectrequired
One option: FlowsProfileMetricCondition
typestringrequired
profile-metricmetric_idstringrequired
measurementstringrequired
countsummeasurement_filterobjectrequired
timeframe_filterobjectrequired
metric_filtersarray of objectscan be null
One option: ProfileRandomSampleCondition
typestringrequired
profile-samplepercentageintegerrequired
One option: ProfileHasCustomObjectCondition
typestringrequired
profile-has-custom-objectobject_type_idstringrequired
object_type_relationship_idstringrequired
filterobjectrequired
filtersarray of objectsrequired
One option: ProfilePermissionsCondition
typestringrequired
profile-permissionspermissionobjectrequired
channelstringrequired
email_click_trackingemail_open_trackingwhatsapp_marketingwhatsapp_transactional
One option: ProfileHasNotReceivedEmailMessageCondition
typestringrequired
profile-not-sent-emailtimeframe_filterobjectrequired
One option: ProfileHasNotReceivedSmsMessageCondition
typestringrequired
profile-not-sent-smstimeframe_filterobjectrequired
One option: ProfileHasNotReceivedPushMessageCondition
typestringrequired
profile-not-sent-pushtimeframe_filterobjectrequired
namestringcan be null
idstringcan be null
One option: FlowWebhook
urlstringrequiredcan be null
headersobjectcan be null
bodystringcan be null
namestringcan be null
idstringcan be null
One option: FlowWhatsApp
idstringcan be null
namestringcan be null
vendor_idstringcan be null
smart_sending_enabledboolean
transactionalboolean
add_tracking_paramsboolean
additional_filtersobjectcan be null
additional_filters: 1 field
condition_groupsarray of objectsrequired
condition_groups: 1 field
conditionsarray of objectsrequired
One option: ProfilePropertyCondition
typestringrequired
profile-propertypropertystringrequired
filterobjectrequired
One option: ProfileHasGroupMembershipCondition
typestringrequired
profile-group-membershipis_memberbooleanrequired
truegroup_idsarray of stringsrequired
timeframe_filterobjectcan be null
One option: ProfileNoGroupMembershipCondition
typestringrequired
profile-group-membershipis_memberbooleanrequired
falsegroup_idsarray of stringsrequired
One option: ProfileRegionCondition
typestringrequired
profile-regionin_regionbooleanrequired
regionstringrequired
european_unionunited_states
One option: ProfilePostalCodeDistanceCondition
typestringrequired
profile-postal-code-distancecountry_codestringrequired
postal_codestringrequired
unitstringrequired
kilometersmilesfilterobjectrequired
One option: ProfilePredictiveAnalyticsDateCondition
dimensionstringrequired
expected_date_of_next_purchasefilterobjectrequired
typestringrequired
profile-predictive-analytics
One option: ProfilePredictiveAnalyticsStringCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
predicted_genderfilterobjectrequired
One option: ProfilePredictiveAnalyticsNumericCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
average_days_between_ordersaverage_order_valuechurn_probabilityhistoric_clvhistoric_number_of_orderspredicted_clvpredicted_number_of_orderstotal_clvfilterobjectrequired
One option: ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
channel_affinitymeasurementstringrequired
prioritypredicted_channelstringrequired
emailpushsmswhatsappfilterobjectrequired
One option: ProfilePredictiveAnalyticsChannelAffinityRankCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
channel_affinitymeasurementstringrequired
rankpredicted_channelstringrequired
emailpushsmswhatsappfilterobjectrequired
One option: ProfileMarketingConsentCondition
typestringrequired
profile-marketing-consentconsentobjectrequired
One option: FlowsProfileMetricCondition
typestringrequired
profile-metricmetric_idstringrequired
measurementstringrequired
countsummeasurement_filterobjectrequired
timeframe_filterobjectrequired
metric_filtersarray of objectscan be null
One option: ProfileRandomSampleCondition
typestringrequired
profile-samplepercentageintegerrequired
One option: ProfileHasCustomObjectCondition
typestringrequired
profile-has-custom-objectobject_type_idstringrequired
object_type_relationship_idstringrequired
filterobjectrequired
filtersarray of objectsrequired
One option: ProfilePermissionsCondition
typestringrequired
profile-permissionspermissionobjectrequired
channelstringrequired
email_click_trackingemail_open_trackingwhatsapp_marketingwhatsapp_transactional
One option: ProfileHasNotReceivedEmailMessageCondition
typestringrequired
profile-not-sent-emailtimeframe_filterobjectrequired
One option: ProfileHasNotReceivedSmsMessageCondition
typestringrequired
profile-not-sent-smstimeframe_filterobjectrequired
One option: ProfileHasNotReceivedPushMessageCondition
typestringrequired
profile-not-sent-pushtimeframe_filterobjectrequired
automation_idstringcan be null
expiry_hoursintegercan be null
One option: FlowWhatsAppWithAC
idstringcan be null
namestringcan be null
vendor_idstringcan be null
smart_sending_enabledboolean
transactionalboolean
add_tracking_paramsboolean
additional_filtersobjectcan be null
additional_filters: 1 field
condition_groupsarray of objectsrequired
condition_groups: 1 field
conditionsarray of objectsrequired
One option: ProfilePropertyCondition
typestringrequired
profile-propertypropertystringrequired
filterobjectrequired
One option: ProfileHasGroupMembershipCondition
typestringrequired
profile-group-membershipis_memberbooleanrequired
truegroup_idsarray of stringsrequired
timeframe_filterobjectcan be null
One option: ProfileNoGroupMembershipCondition
typestringrequired
profile-group-membershipis_memberbooleanrequired
falsegroup_idsarray of stringsrequired
One option: ProfileRegionCondition
typestringrequired
profile-regionin_regionbooleanrequired
regionstringrequired
european_unionunited_states
One option: ProfilePostalCodeDistanceCondition
typestringrequired
profile-postal-code-distancecountry_codestringrequired
postal_codestringrequired
unitstringrequired
kilometersmilesfilterobjectrequired
One option: ProfilePredictiveAnalyticsDateCondition
dimensionstringrequired
expected_date_of_next_purchasefilterobjectrequired
typestringrequired
profile-predictive-analytics
One option: ProfilePredictiveAnalyticsStringCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
predicted_genderfilterobjectrequired
One option: ProfilePredictiveAnalyticsNumericCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
average_days_between_ordersaverage_order_valuechurn_probabilityhistoric_clvhistoric_number_of_orderspredicted_clvpredicted_number_of_orderstotal_clvfilterobjectrequired
One option: ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
channel_affinitymeasurementstringrequired
prioritypredicted_channelstringrequired
emailpushsmswhatsappfilterobjectrequired
One option: ProfilePredictiveAnalyticsChannelAffinityRankCondition
typestringrequired
profile-predictive-analyticsdimensionstringrequired
channel_affinitymeasurementstringrequired
rankpredicted_channelstringrequired
emailpushsmswhatsappfilterobjectrequired
One option: ProfileMarketingConsentCondition
typestringrequired
profile-marketing-consentconsentobjectrequired
One option: FlowsProfileMetricCondition
typestringrequired
profile-metricmetric_idstringrequired
measurementstringrequired
countsummeasurement_filterobjectrequired
timeframe_filterobjectrequired
metric_filtersarray of objectscan be null
One option: ProfileRandomSampleCondition
typestringrequired
profile-samplepercentageintegerrequired
One option: ProfileHasCustomObjectCondition
typestringrequired
profile-has-custom-objectobject_type_idstringrequired
object_type_relationship_idstringrequired
filterobjectrequired
filtersarray of objectsrequired
One option: ProfilePermissionsCondition
typestringrequired
profile-permissionspermissionobjectrequired
channelstringrequired
email_click_trackingemail_open_trackingwhatsapp_marketingwhatsapp_transactional
One option: ProfileHasNotReceivedEmailMessageCondition
typestringrequired
profile-not-sent-emailtimeframe_filterobjectrequired
One option: ProfileHasNotReceivedSmsMessageCondition
typestringrequired
profile-not-sent-smstimeframe_filterobjectrequired
One option: ProfileHasNotReceivedPushMessageCondition
typestringrequired
profile-not-sent-pushtimeframe_filterobjectrequired
automation_idstringcan be null
expiry_hoursintegercan be null
relationshipsobject
relationships: 2 fields
flow-actionobject
flow-action: 2 fields
dataobject
data: 2 fields
typestringrequired
flow-actionidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
templateobject
template: 2 fields
dataobject
data: 2 fields
typestringrequired
templateidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
linksobject
links: 3 fields
selfstring (uri)required
prevstring (uri)
nextstring (uri)
metaobject
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject