Get Flows

get

https://a.klaviyo.com/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

Query Params

fields[flow-action]

array of strings

For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets

fields[flow-action]

fields[flow]

array of strings

For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets

fields[flow]

filter

string

For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering
Allowed field(s)/operator(s):
id: any
name: contains, ends-with, equals, starts-with
status: equals
archived: equals
created: equals, greater-or-equal, greater-than, less-or-equal, less-than
updated: equals, greater-or-equal, greater-than, less-or-equal, less-than
trigger_type: equals

include

array of strings

For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships

include

sort

string

enum

For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting

Headers

revision

string

required

Defaults to 2023-01-24

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

200

4XXClient Error

5XXServer Error