Klaviyo API

Getting access, Developing, Testing

Back to Klaviyo

Get Flow

Get a flow with the given flow ID.\nInclude parameters can be provided to get the following related resource data: flow-actions

Rate limits:
Burst: 3/s
Steady: 60/m\n\nScopes:\nFlows Read

Input

type: object properties: parameters: type: object properties: id: type: string fields[flow-action]: type: array items: type: string enum: - action_type - status - created - updated - settings - tracking_options - send_options - send_options.use_smart_sending - send_options.is_transactional - render_options - render_options.shorten_links - render_options.add_org_prefix - render_options.add_info_link - render_options.add_opt_out_language description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets fields[flow]: type: array items: type: string enum: - name - status - archived - created - updated - trigger_type description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets include: type: array items: type: string enum: - flow-actions description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships revision: type: string default: '2023-02-22' description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])' required: - id - revision title: Parameters

Output

type: object required: - data properties: data: type: object required: - type - id - attributes - links properties: type: type: string enum: - flow id: type: string attributes: type: object properties: name: type: string status: type: string archived: type: boolean created: type: string format: date-time example: '2022-11-08T00:00:00' updated: type: string format: date-time example: '2022-11-08T00:00:00' trigger_type: type: string links: type: object required: - self properties: self: type: string format: uri relationships: type: object properties: flow-actions: type: object required: - data properties: data: type: array items: type: object required: - type - id properties: type: type: string enum: - flow-action id: type: string included: type: array items: type: object required: - type - id - attributes - links properties: type: type: string enum: - flow-action id: type: string attributes: type: object properties: action_type: type: string status: type: string created: type: string format: date-time example: '2022-11-08T00:00:00' updated: type: string format: date-time example: '2022-11-08T00:00:00' settings: type: object tracking_options: oneOf: - type: object properties: add_utm: type: boolean utm_params: type: array items: type: object required: - name - value properties: name: type: string value: type: string is_tracking_opens: type: boolean is_tracking_clicks: type: boolean required: - add_utm - utm_params - is_tracking_opens - is_tracking_clicks - type: object properties: add_utm: type: boolean utm_params: type: array items: type: object required: - name - value properties: name: type: string value: type: string required: - add_utm - utm_params send_options: type: object required: - use_smart_sending - is_transactional properties: use_smart_sending: type: boolean is_transactional: type: boolean render_options: type: object required: - shorten_links - add_org_prefix - add_info_link - add_opt_out_language properties: shorten_links: type: boolean add_org_prefix: type: boolean add_info_link: type: boolean add_opt_out_language: type: boolean links: type: object required: - self properties: self: type: string format: uri