Method: KlaviyoAPI::FlowsApi#get_flows

Defined in:

lib/klaviyo-api-sdk/api/flows_api.rb

#get_flows(opts = {}) ⇒ Hash<String, Object>

Get 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`

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :fields_flow_action (Array<String>) —

  For more information please visit developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets

• :fields_flow (Array<String>) —

  For more information please visit developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets

• :fields_tag (Array<String>) —

  For more information please visit developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets

• :filter (String) —

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

• :include (Array<String>) —

  For more information please visit developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships

• :page_cursor (String) —

  For more information please visit developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination

• :page_size (Integer) —

  Default: 50. Min: 1. Max: 50. (default to 50)

• :sort (String) —

  For more information please visit developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting

Returns:

• (Hash<String, Object>)

# File 'lib/klaviyo-api-sdk/api/flows_api.rb', line 1071

def get_flows(opts = {})
  data, _status_code, _headers = get_flows_with_http_info(opts)
  data
end