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 Use filters to narrow your results. Request specific fields using sparse fieldsets. 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

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/v2022-10-17/reference/api-overview#sparse-fieldsets
fields[flow]stringFor more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
filterstringFor more information please visit https://developers.klaviyo.com/en/v2022-10-17/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/v2022-10-17/reference/api-overview#relationships
includestringFor more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
sortstringFor more information please visit https://developers.klaviyo.com/en/v2022-10-17/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;in velit ut&quot;,&quot;attributes&quot;:{&quot;name&quot;:&quot;cupidatat laborum&quot;,&quot;status&quot;:&quot;ut si&quot;,&quot;archived&quot;:true,&quot;created&quot;:&quot;1947-03-31T06:18:52.804Z&quot;,&quot;updated&quot;:&quot;1999-01-12T08:54:18.023Z&quot;,&quot;trigger_type&quot;:&quot;elit adipisicing aliqua&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;http://hJPvHbTcaSfhJVUSKom.jqcyCM&quot;},&quot;relationships&quot;:{&quot;flow-actions&quot;:{&quot;data&quot;:[{&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}]}},&quot;included&quot;:[{&quot;type&quot;:&quot;flow-action&quot;,&quot;id&quot;:&quot;sed laborum nisi&quot;,&quot;attributes&quot;:{&quot;action_type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;status&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;created&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;updated&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;settings&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;tracking_options&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;send_options&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;render_options&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;links&quot;:{&quot;self&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}},{&quot;type&quot;:&quot;flow-action&quot;,&quot;id&quot;:&quot;ea in anim&quot;,&quot;attributes&quot;:{&quot;action_type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;status&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;created&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;updated&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;settings&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;tracking_options&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;send_options&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;render_options&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;links&quot;:{&quot;self&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}}]},{&quot;type&quot;:&quot;flow&quot;,&quot;id&quot;:&quot;culpa labore&quot;,&quot;attributes&quot;:{&quot;name&quot;:&quot;ut&quot;,&quot;status&quot;:&quot;cupidatat in&quot;,&quot;archived&quot;:false,&quot;created&quot;:&quot;1976-08-12T13:14:27.703Z&quot;,&quot;updated&quot;:&quot;2010-11-16T20:48:00.589Z&quot;,&quot;trigger_type&quot;:&quot;Duis magna et&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;http://JoeykdQzLKGHNGJPCzyXD.bnmhBKnS0BsBgmna7DaRlJi8Kcx5ozB+jLDTUFkoke&quot;},&quot;relationships&quot;:{&quot;flow-actions&quot;:{&quot;data&quot;:[{&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}]}},&quot;included&quot;:[{&quot;type&quot;:&quot;flow-action&quot;,&quot;id&quot;:&quot;ullamco irure nisi&quot;,&quot;attributes&quot;:{&quot;action_type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;status&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;created&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;updated&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;settings&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;tracking_options&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;send_options&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;render_options&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;links&quot;:{&quot;self&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}},{&quot;type&quot;:&quot;flow-action&quot;,&quot;id&quot;:&quot;anim nulla dolore&quot;,&quot;attributes&quot;:{&quot;action_type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;status&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;created&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;updated&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;settings&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;tracking_options&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;send_options&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;render_options&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},&quot;links&quot;:{&quot;self&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}}]}],&quot;links&quot;:{&quot;self&quot;:&quot;http://fioBSHDx.ckfcadz-s4vZp1NO+SWG.iN3UGZSNY+XdMfIYhY5ARX+xzMn,NN9pCZ9bQnSk8qS&quot;,&quot;first&quot;:&quot;http://SwrRtDrOdDUNxU.cmvkD7L2zffiPOmpVkPdJ4vP4u2MPw&quot;,&quot;last&quot;:&quot;http://VLUyvbsew.fqjGY1gP2XdJ962VUqmNz0ihDEVRsSMNNg-q8e4nnn7cphnQhR4.CwuZr4yWz3ZUe&quot;,&quot;prev&quot;:&quot;http://k.anmfQJGMtD9fZeIM5SDMMkv7hkjpziLPMHaZKYhxRWJPkvdf9WKAv2.rDO&quot;,&quot;next&quot;:&quot;https://LZzPt.oqwb0K-Nhs4jJKar-RMWsn4eDzP5mRbTg53Qvxd,wpbnOhAmbnjWSsO2DsGh61btVLKXJJFZjaK1&quot;}}