Get Flow Action Messages

GET {{baseUrl}}/api/flow-actions/:id/flow-messages/

Get all flow messages associated with the given action ID.

Flow messages can be sorted by the following fields, in ascending and descending order:

ascending: id, name, created, updated descending: -id, -name, -created, -updated

Returns a maximum of 50 flows per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: page[size] and page[number]

Rate limits:
Burst: 3/s
Steady: 60/m

Scopes: flows:read

Request Params

KeyDatatypeRequiredDescription
fields[flow-message]stringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
filterstringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering&lt;br&gt;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
page[size]numberDefault: 50. Min: 1. Max: 100.
sortstringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Acceptstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;type&quot;:&quot;flow-message&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;attributes&quot;:{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;channel&quot;:&quot;\u003cstring\u003e&quot;,&quot;content&quot;:{&quot;subject&quot;:&quot;\u003cstring\u003e&quot;,&quot;preview_text&quot;:&quot;\u003cstring\u003e&quot;,&quot;from_email&quot;:&quot;\u003cstring\u003e&quot;,&quot;from_label&quot;:&quot;\u003cstring\u003e&quot;,&quot;reply_to_email&quot;:&quot;\u003cstring\u003e&quot;,&quot;cc_email&quot;:&quot;\u003cstring\u003e&quot;,&quot;bcc_email&quot;:&quot;\u003cstring\u003e&quot;},&quot;created&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updated&quot;:&quot;\u003cdateTime\u003e&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;},&quot;relationships&quot;:{&quot;flow-action&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}},&quot;template&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}}}},{&quot;type&quot;:&quot;flow-message&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;attributes&quot;:{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;channel&quot;:&quot;\u003cstring\u003e&quot;,&quot;content&quot;:{&quot;subject&quot;:&quot;\u003cstring\u003e&quot;,&quot;preview_text&quot;:&quot;\u003cstring\u003e&quot;,&quot;from_email&quot;:&quot;\u003cstring\u003e&quot;,&quot;from_label&quot;:&quot;\u003cstring\u003e&quot;,&quot;reply_to_email&quot;:&quot;\u003cstring\u003e&quot;,&quot;cc_email&quot;:&quot;\u003cstring\u003e&quot;,&quot;bcc_email&quot;:&quot;\u003cstring\u003e&quot;},&quot;created&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updated&quot;:&quot;\u003cdateTime\u003e&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;},&quot;relationships&quot;:{&quot;flow-action&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}},&quot;template&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}}}}],&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;first&quot;:&quot;\u003curi\u003e&quot;,&quot;last&quot;:&quot;\u003curi\u003e&quot;,&quot;prev&quot;:&quot;\u003curi\u003e&quot;,&quot;next&quot;:&quot;\u003curi\u003e&quot;}}