Method: KlaviyoAPI::FlowsApi#get_flow

Defined in:

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

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

Get Flow Get a flow with the given flow ID.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `flows:read`

Parameters:

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

  the optional parameters

Options Hash (opts):

• :additional_fields_flow (Array<String>) —

  Request additional fields not included by default in the response. Supported values: &#39;definition&#39;

• :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

• :include (Array<String>) —

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

Returns:

• (Hash<String, Object>)

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

def get_flow(id, opts = {})
  data, _status_code, _headers = get_flow_with_http_info(id, opts)
  data
end