Get Flows

get

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

Query Params

fields[flow-action]

array of strings

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

fields[flow-action]

fields[flow]

array of strings

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

fields[flow]

fields[tag]

array of strings

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

fields[tag]

filter

string

For more information please visit https://developers.klaviyo.com/en/v2023-12-15/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-12-15/reference/api-overview#relationships

include

page[cursor]

string

For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination

page[size]

integer

1 to 50

Defaults to 50

Default: 50. Min: 1. Max: 50.

sort

string

enum

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

Headers

revision

string

required

Defaults to 2023-12-15

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

Responses

Language

Credentials

Header

Response

Choose an example:

application/json

200Success

4XXClient Error

5XXServer Error