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
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/v2023-01-24/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/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/v2023-01-24/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":"tempor labore nisi","attributes":{"name":"et est ullamco incididunt","channel":"non nostrud","content":{"subject":"Lorem culpa eiusmod adipisicing","preview_text":"amet consequat minim reprehenderit","from_email":"culpa","from_name":"quis elit"},"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"https://q.jggpIKh8.BRxGK2YDG4oYioJEjWlbA0yi.uYJRxd2Z2-bY886kMnTa-s5nbzj"}},{"type":"flow-message","id":"elit qui est officia","attributes":{"name":"ex","channel":"in ut ea commodo Ut","content":{"subject":"a","preview_text":"velit officia do dolor","from_email":"ullamco consectetur ad","from_name":"dolor ex Duis dolore"},"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"http://L.kfnwXcyQFQWk"}}],"links":{"self":"https://zGmqd.amw8pavgOXq6us6-DVs-X+qNg3ZTFQ3hEf,OG1Oh-wGW84yDZREZRgZ","first":"http://IJPWdbFbspBf.lsFlf-","last":"https://JUeHRpvL.lvN,8OwlN","prev":"https://fhiXRpBZwiIjOYvlf.bhLY7elzcIPSz7Z86y9-7nDTkHxZRgFdlSqTl7N.03dgj,OK2ugiwM2uFYAjvnLWbAME","next":"http://IUUcICYOiVscGOietfdZsf.cxrK.bkaJ+IoZNovfSwIRJnAocA0CZ-w9QIVNZ6xuf1evw+SoDRlXh5MqKtwUt+"}}