Get Messages For Flow Action
GET {{baseUrl}}/api/flow-actions/:action_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
Use filters to narrow your results. Request specific fields using sparse fieldsets.
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
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[flow-message] | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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 | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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":"sint dolore labore qui","attributes":{"name":"sunt Lorem ea ex","channel":"cupidatat","content":{"subject":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"preview_text":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"from_email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"from_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"created":"1971-02-14T12:09:48.797Z","updated":"1963-06-27T13:26:12.858Z"},"links":{"self":"http://zeuEadW.gxYTQ-yKoRPgPSwWUY79XeB,.r+q0SMTj8FGNjjpn75JDHRFTE1H3tF7Gqos"}},{"type":"flow-message","id":"ut laboris et","attributes":{"name":"aute aliqua ut Duis","channel":"voluptate magna consectetur ali","content":{"subject":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"preview_text":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"from_email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"from_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"created":"1979-07-03T23:13:54.195Z","updated":"1964-09-30T12:03:50.122Z"},"links":{"self":"https://ugCu.meeztaSL,hlmg.sidp9nRoYXYaQag9v60En1H0b06ucCnEzYRVW1eOvY+dVxIYRK"}}],"links":{"self":"http://GAeKkwerwVXgJxwpb.fnyoJJEYcwK+isvCNEqlpgawzk8j6.6dBdLjp0XYABAEm","first":"https://XpgXSY.fggocjSKIqeK+OYDU-syVm2Djt","last":"http://kouTlWHmKKbzwQQxozussKOeZILe.xbpnIZq8p15Sg.E-caeuXzoLS8ZqpORs","prev":"https://PSiMXVKlqMDwJuBruU.ndculNWgZ7FBH553B4vmSHn-mG-7Oxy6J.LQncjpVPZ-L3mJfuuXwrbZVA2gZ1c3GgDP6D","next":"https://CTfMXarOcdPknQmqrNtJUmFsyxSUQW.tgve42fGAdWIShM+OOUea.jjotnnVC-8lwYvMC,r"}}