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
Key | Datatype | Required | Description |
---|---|---|---|
fields[flow-action] | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | |
fields[flow] | 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>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/v2023-01-24/reference/api-overview#relationships | |
include | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | |
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","id":"tempor et ex occaecat","attributes":{"name":"Lorem Excepteur","status":"reprehenderit exerc","archived":false,"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","trigger_type":"sunt dolor adipisicing"},"links":{"self":"http://JkpLXfFMxbSDbYaLaQMfymScrz.nhctcrm3GtTPEoXZZybLie"},"relationships":{"flow-actions":{"data":[{"type":"flow-action","id":"do Duis ullamco"},{"type":"flow-action","id":"elit sed amet veniam"}]}}},{"type":"flow","id":"culpa minim pariatur","attributes":{"name":"commodo laboris dolore sunt","status":"Duis","archived":false,"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","trigger_type":"eiusmod aliquip minim"},"links":{"self":"https://KQYCCdTTi.ebdA5zjIuhMM+jAyVJqO1EkFtVc4nfIhP6.VwbPAANzkLwdZyXXQUPVOUty"},"relationships":{"flow-actions":{"data":[{"type":"flow-action","id":"anim commodo"},{"type":"flow-action","id":"fugiat sunt"}]}}}],"links":{"self":"https://uXdcwQVQlMHsgNoYo.npV","first":"https://nXKkSKgqUGqAbAgaH.sclfanae,57Bk,S2abQhm4P9hsCp.greCDlCODR","last":"https://yTSPpOQsZJKTezLnsSiTlWthqdCFbq.qlappwEJczvmCn4nEHdYC.lYZSt-HmyXXsCMp.hJ0kfuJBwbvMw","prev":"http://OUlKLGZUfCEnMUU.roirmVgElp2LTqxSCjImtkWtxriSUjr+De,-0ashlaJk,GCkYA4KPqdA","next":"http://GRiOikeiVfsxRSEPAcShRIW.ppbcUrnqEiVXczlLITxjv7mk.lxtMLNrxM7aF+KDD0is"},"included":[{"type":"flow-action","id":"tempor ad mollit et pariatur","attributes":{"action_type":"non","status":"voluptate incididunt ei","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","settings":{},"tracking_options":{"add_utm":false,"utm_params":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"is_tracking_opens":false,"is_tracking_clicks":true},"send_options":{"use_smart_sending":false,"is_transactional":false},"render_options":{"shorten_links":false,"add_org_prefix":true,"add_info_link":true,"add_opt_out_language":false}},"links":{"self":"https://ZdTJhdGyjFrpWOaMLjxPZRq.gcbqs+WHf9ASQ"}},{"type":"flow-action","id":"id ea eiusmod Excepteur aliquip","attributes":{"action_type":"ut","status":"aute proident dolor laborum","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","settings":{},"tracking_options":{"add_utm":false,"utm_params":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"is_tracking_opens":false,"is_tracking_clicks":true},"send_options":{"use_smart_sending":true,"is_transactional":false},"render_options":{"shorten_links":false,"add_org_prefix":false,"add_info_link":true,"add_opt_out_language":false}},"links":{"self":"https://wLCYBwuSSdvnb.hkxvJ+4145aBcK495Z8FimM5o3YbD3oqEctS8yyq,hjzpYW+XJIMVgI-hPwJg"}}]}