Get Messages For Flow Action
GET {{baseUrl}}/api/flow-actions/:action_id/flow-messages/
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
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[flow-message] | string | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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 | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | |
page[size] | number | Default: 50. Min: 1. Max: 50. | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"flow-message","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","channel":"\u003cstring\u003e","content":{"subject":"\u003cstring\u003e","preview_text":"\u003cstring\u003e","from_email":"\u003cstring\u003e","from_name":"\u003cstring\u003e"},"created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"flow-action":{"data":[{"type":"flow-action","id":"\u003cstring\u003e"},{"type":"flow-action","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"flow-message","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","channel":"\u003cstring\u003e","content":{"subject":"\u003cstring\u003e","preview_text":"\u003cstring\u003e","from_email":"\u003cstring\u003e","from_name":"\u003cstring\u003e"},"created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"flow-action":{"data":[{"type":"flow-action","id":"\u003cstring\u003e"},{"type":"flow-action","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"}}