Get Flows

GET {{baseUrl}}/api/flows/

Get all flows in an account. Flows can be sorted by the following fields, in ascending and descending order: id, name, status, trigger_type, created, updated Include parameters can be provided to get the following related resource data: flow-actions 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-action]stringFor more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
fields[flow]stringFor more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
filterstringFor more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):<br>id: any<br>name: contains, ends-with, equals, starts-with<br>status: equals<br>archived: equals<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<br>trigger_type: equals
includestringFor more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
includestringFor more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
sortstringFor more information please visit https://developers.klaviyo.com/en/v2023-01-24/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&quot;,&quot;id&quot;:&quot;tempor et ex occaecat&quot;,&quot;attributes&quot;:{&quot;name&quot;:&quot;Lorem Excepteur&quot;,&quot;status&quot;:&quot;reprehenderit exerc&quot;,&quot;archived&quot;:false,&quot;created&quot;:&quot;2022-11-08T00:00:00&quot;,&quot;updated&quot;:&quot;2022-11-08T00:00:00&quot;,&quot;trigger_type&quot;:&quot;sunt dolor adipisicing&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;http://JkpLXfFMxbSDbYaLaQMfymScrz.nhctcrm3GtTPEoXZZybLie&quot;},&quot;relationships&quot;:{&quot;flow-actions&quot;:{&quot;data&quot;:[{&quot;type&quot;:&quot;flow-action&quot;,&quot;id&quot;:&quot;do Duis ullamco&quot;},{&quot;type&quot;:&quot;flow-action&quot;,&quot;id&quot;:&quot;elit sed amet veniam&quot;}]}}},{&quot;type&quot;:&quot;flow&quot;,&quot;id&quot;:&quot;culpa minim pariatur&quot;,&quot;attributes&quot;:{&quot;name&quot;:&quot;commodo laboris dolore sunt&quot;,&quot;status&quot;:&quot;Duis&quot;,&quot;archived&quot;:false,&quot;created&quot;:&quot;2022-11-08T00:00:00&quot;,&quot;updated&quot;:&quot;2022-11-08T00:00:00&quot;,&quot;trigger_type&quot;:&quot;eiusmod aliquip minim&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;https://KQYCCdTTi.ebdA5zjIuhMM+jAyVJqO1EkFtVc4nfIhP6.VwbPAANzkLwdZyXXQUPVOUty&quot;},&quot;relationships&quot;:{&quot;flow-actions&quot;:{&quot;data&quot;:[{&quot;type&quot;:&quot;flow-action&quot;,&quot;id&quot;:&quot;anim commodo&quot;},{&quot;type&quot;:&quot;flow-action&quot;,&quot;id&quot;:&quot;fugiat sunt&quot;}]}}}],&quot;links&quot;:{&quot;self&quot;:&quot;https://uXdcwQVQlMHsgNoYo.npV&quot;,&quot;first&quot;:&quot;https://nXKkSKgqUGqAbAgaH.sclfanae,57Bk,S2abQhm4P9hsCp.greCDlCODR&quot;,&quot;last&quot;:&quot;https://yTSPpOQsZJKTezLnsSiTlWthqdCFbq.qlappwEJczvmCn4nEHdYC.lYZSt-HmyXXsCMp.hJ0kfuJBwbvMw&quot;,&quot;prev&quot;:&quot;http://OUlKLGZUfCEnMUU.roirmVgElp2LTqxSCjImtkWtxriSUjr+De,-0ashlaJk,GCkYA4KPqdA&quot;,&quot;next&quot;:&quot;http://GRiOikeiVfsxRSEPAcShRIW.ppbcUrnqEiVXczlLITxjv7mk.lxtMLNrxM7aF+KDD0is&quot;},&quot;included&quot;:[{&quot;type&quot;:&quot;flow-action&quot;,&quot;id&quot;:&quot;tempor ad mollit et pariatur&quot;,&quot;attributes&quot;:{&quot;action_type&quot;:&quot;non&quot;,&quot;status&quot;:&quot;voluptate incididunt ei&quot;,&quot;created&quot;:&quot;2022-11-08T00:00:00&quot;,&quot;updated&quot;:&quot;2022-11-08T00:00:00&quot;,&quot;settings&quot;:{},&quot;tracking_options&quot;:{&quot;add_utm&quot;:false,&quot;utm_params&quot;:[{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}],&quot;is_tracking_opens&quot;:false,&quot;is_tracking_clicks&quot;:true},&quot;send_options&quot;:{&quot;use_smart_sending&quot;:false,&quot;is_transactional&quot;:false},&quot;render_options&quot;:{&quot;shorten_links&quot;:false,&quot;add_org_prefix&quot;:true,&quot;add_info_link&quot;:true,&quot;add_opt_out_language&quot;:false}},&quot;links&quot;:{&quot;self&quot;:&quot;https://ZdTJhdGyjFrpWOaMLjxPZRq.gcbqs+WHf9ASQ&quot;}},{&quot;type&quot;:&quot;flow-action&quot;,&quot;id&quot;:&quot;id ea eiusmod Excepteur aliquip&quot;,&quot;attributes&quot;:{&quot;action_type&quot;:&quot;ut&quot;,&quot;status&quot;:&quot;aute proident dolor laborum&quot;,&quot;created&quot;:&quot;2022-11-08T00:00:00&quot;,&quot;updated&quot;:&quot;2022-11-08T00:00:00&quot;,&quot;settings&quot;:{},&quot;tracking_options&quot;:{&quot;add_utm&quot;:false,&quot;utm_params&quot;:[{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}],&quot;is_tracking_opens&quot;:false,&quot;is_tracking_clicks&quot;:true},&quot;send_options&quot;:{&quot;use_smart_sending&quot;:true,&quot;is_transactional&quot;:false},&quot;render_options&quot;:{&quot;shorten_links&quot;:false,&quot;add_org_prefix&quot;:false,&quot;add_info_link&quot;:true,&quot;add_opt_out_language&quot;:false}},&quot;links&quot;:{&quot;self&quot;:&quot;https://wLCYBwuSSdvnb.hkxvJ+4145aBcK495Z8FimM5o3YbD3oqEctS8yyq,hjzpYW+XJIMVgI-hPwJg&quot;}}]}