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