Get Flows
GET {{baseUrl}}/api/flows/
Get all flows in an account.
Returns a maximum of 50 flows per request, which can be paginated with cursor-based 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/v2024-02-15/reference/api-overview#sparse-fieldsets | |
fields[flow] | string | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | |
fields[tag] | string | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/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/v2024-02-15/reference/api-overview#relationships | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | |
page[size] | number | Default: 50. Min: 1. Max: 50. | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/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":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","status":"\u003cstring\u003e","archived":"\u003cboolean\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","trigger_type":"Added to List"},"links":{"self":"\u003curi\u003e"},"relationships":{"flow-actions":{"data":[{"type":"flow-action","id":"\u003cstring\u003e"},{"type":"flow-action","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"tags":{"data":[{"type":"tag","id":"\u003cstring\u003e"},{"type":"tag","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"flow","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","status":"\u003cstring\u003e","archived":"\u003cboolean\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","trigger_type":"Added to List"},"links":{"self":"\u003curi\u003e"},"relationships":{"flow-actions":{"data":[{"type":"flow-action","id":"\u003cstring\u003e"},{"type":"flow-action","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"tags":{"data":[{"type":"tag","id":"\u003cstring\u003e"},{"type":"tag","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"},"included":[{"type":"flow-action","id":"\u003cstring\u003e","attributes":{"action_type":"\u003cstring\u003e","status":"\u003cstring\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","settings":{},"tracking_options":{"add_utm":"\u003cboolean\u003e","utm_params":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"is_tracking_opens":"\u003cboolean\u003e","is_tracking_clicks":"\u003cboolean\u003e"},"send_options":{"use_smart_sending":"\u003cboolean\u003e","is_transactional":"\u003cboolean\u003e"},"render_options":{"shorten_links":"\u003cboolean\u003e","add_org_prefix":"\u003cboolean\u003e","add_info_link":"\u003cboolean\u003e","add_opt_out_language":"\u003cboolean\u003e"}},"links":{"self":"\u003curi\u003e"}},{"type":"flow-action","id":"\u003cstring\u003e","attributes":{"action_type":"\u003cstring\u003e","status":"\u003cstring\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","settings":{},"tracking_options":{"add_utm":"\u003cboolean\u003e","utm_params":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"is_tracking_opens":"\u003cboolean\u003e","is_tracking_clicks":"\u003cboolean\u003e"},"send_options":{"use_smart_sending":"\u003cboolean\u003e","is_transactional":"\u003cboolean\u003e"},"render_options":{"shorten_links":"\u003cboolean\u003e","add_org_prefix":"\u003cboolean\u003e","add_info_link":"\u003cboolean\u003e","add_opt_out_language":"\u003cboolean\u003e"}},"links":{"self":"\u003curi\u003e"}}]}