Get Messages For Flow Action

get https://a.klaviyo.com/api/flow-actions/{id}/flow-messages

🚧
This endpoint is in beta and subject to change.
A beta revision header (2025-04-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our versioning and deprecation policy for more information.

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

Path Params

string

required

Query Params

fields[flow-message]

array of strings

For more information please visit https://developers.klaviyo.com/en/v2025-04-15.pre/reference/api-overview#sparse-fieldsets

fields[flow-message]

filter

string

For more information please visit https://developers.klaviyo.com/en/v2025-04-15.pre/reference/api-overview#filtering
Allowed field(s)/operator(s):
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

page[cursor]

string

For more information please visit https://developers.klaviyo.com/en/v2025-04-15.pre/reference/api-overview#pagination

page[size]

integer

1 to 50

Defaults to 50

Default: 50. Min: 1. Max: 50.

sort

string

For more information please visit https://developers.klaviyo.com/en/v2025-04-15.pre/reference/api-overview#sorting

Headers

revision

string

required

Defaults to 2025-04-15.pre

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://a.klaviyo.com/api/flow-actions/id/flow-messages?page[size]=50' \
3
     --header 'Authorization: Klaviyo-API-Key your-private-api-key' \
4
     --header 'accept: application/vnd.api+json' \
5
     --header 'revision: 2025-04-15.pre'


xxxxxxxxxx
170
}
1
{
2
  "data": [
3
    {
4
      "type": "flow-message",
5
      "id": "string",
6
      "attributes": {
7
        "created": "2022-11-08T00:00:00+00:00",
8
        "updated": "2022-11-08T00:00:00+00:00",
9
        "definition": {
10
          "from_email": "string",
11
          "from_label": "string",
12
          "reply_to_email": "string",
13
          "cc_email": "string",
14
          "bcc_email": "string",
15
          "subject_line": "string",
16
          "preview_text": "string",
17
          "template_id": "string",
18
          "smart_sending_enabled": true,
19
          "transactional": false,
20
          "add_tracking_params": false,
21
          "custom_tracking_params": [
22
            {
23
              "param": "string",
24
              "value": "string"
25
            }

200Success

4XXClient Error

5XXServer Error