Klaviyo connection for LinkyFlow

LinkyFlow brings Klaviyo ecommerce data into Excel so teams can browse, edit, validate, and publish from the spreadsheet.

Resources

Read requests

Write actions

Documented fields

352

Workflows you can move into Excel

Each resource below maps to a practical spreadsheet workflow. Read actions bring useful columns into Excel; create and edit actions show what can be reviewed in rows before sending changes.

Account

The Klaviyo account this connection reaches: its organisation, sender defaults, address, timezone and currency.

Read

Account

The Klaviyo account this connection reaches: its organisation, sender defaults, address, timezone and currency.

Route: GET /accounts

Excel formula: =LF.klaviyo.accounts("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`page_size`	number	No	Klaviyo pages this list by a size of its own. Default: 10
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`test_account` default	boolean	—	-
`contact_information`	string	—	-
`default_sender_name`	string	—	-
`default_sender_email`	string	—	-
`website_url`	string	—	-
`organization_name` default	string	—	-
`street_address`	string	—	-
`industry`	string	—	-
`timezone` default	string	—	-
`preferred_currency` default	string	—	-
`public_api_key`	string	—	-
`locale`	string	—	-

Analytics

Campaign Values Reports

What each campaign message achieved over a period — recipients, opens, clicks, conversions, revenue —, as Klaviyo sums it.

Read

Campaign Values Reports

What each campaign message achieved over a period — recipients, opens, clicks, conversions, revenue —, as Klaviyo sums it.

Route: GET /campaignValuesReports

Excel formula: =LF.klaviyo.campaignValuesReports("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`timeframe`	enum	No	The period summed, as Klaviyo names it. Ignored when Start and End are both given. Default: last_30_days Values: today, yesterday, this_week, last_7_days, last_week
`start`	string	No	The start of a period of your own, a year at most (ISO 8601, 2026-01-31T00:00:00Z).
`end`	string	No	The end of that period (ISO 8601, 2026-01-31T00:00:00Z).
`conversion_metric_id`	id	Yes	The metric a conversion is counted on (Placed Order, say).
`statistics`	string	No	The statistics to sum, separated by commas. Empty: recipients, delivered, opens_unique, open_rate, clicks_unique, click_rate, conversions, c...
`channel`	enum	No	The campaigns sent on this channel only. Values: email, sms, push-notification, whatsapp
`campaign_id`	id	No	This campaign only.
`page_size`	number	No	Klaviyo pages this list by a size of its own. Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`campaign_id` default	id	→ campaigns	-
`campaign_message_id` default	id	—	-
`send_channel` default	string	—	-
`click_rate` default	number	—	-
`clicks_unique` default	number	—	-
`conversion_value` default	number	—	-
`conversions` default	number	—	-
`delivered` default	number	—	-
`open_rate` default	number	—	-
`opens_unique` default	number	—	-
`recipients` default	number	—	-
`unsubscribes` default	number	—	-

Events

What the account’s profiles did, one event a row: its metric, its profile, its moment and its properties.

Read

Events

What the account’s profiles did, one event a row: its metric, its profile, its moment and its properties.

Route: GET /events

Excel formula: =LF.klaviyo.events("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`metric_id`	id	No	The events of this metric only.
`profile_id`	id	No	The events of this profile only.
`datetime_from`	string	No	At or after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`datetime_to`	string	No	Before this moment (ISO 8601, 2026-01-31T00:00:00Z).
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: datetime, -datetime, timestamp, -timestamp
`page_size`	number	No	Rows per page (max 1000). Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`timestamp`	number	—	-
`event_properties`	string	—	-
`datetime` default	date	—	-
`uuid`	string	—	-
`metric_id` default	id	—	-
`metric`	string	—	-
`name` default	string	—	-
`profile_id` default	id	—	-

Create

Track Event

Route: POST /mutation/events

Inputs you can set

Name	Type	Required	Description
`backfill`	boolean	No	-
`email`	string	No	-
`external_id`	string	No	-
`metric_name`	string	Yes	-
`phone_number`	string	No	-
`profile_id`	id	No	-
`properties`	string	No	-
`time`	string	No	-
`unique_id`	string	No	-
`value`	number	No	-
`value_currency`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Flow Values Reports

What each flow message achieved over a period — recipients, opens, clicks, conversions, revenue —, as Klaviyo sums it.

Read

Flow Values Reports

What each flow message achieved over a period — recipients, opens, clicks, conversions, revenue —, as Klaviyo sums it.

Route: GET /flowValuesReports

Excel formula: =LF.klaviyo.flowValuesReports("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`timeframe`	enum	No	The period summed, as Klaviyo names it. Ignored when Start and End are both given. Default: last_30_days Values: today, yesterday, this_week, last_7_days, last_week
`start`	string	No	The start of a period of your own, a year at most (ISO 8601, 2026-01-31T00:00:00Z).
`end`	string	No	The end of that period (ISO 8601, 2026-01-31T00:00:00Z).
`conversion_metric_id`	id	Yes	The metric a conversion is counted on (Placed Order, say).
`statistics`	string	No	The statistics to sum, separated by commas. Empty: recipients, delivered, opens_unique, open_rate, clicks_unique, click_rate, conversions, c...
`channel`	enum	No	The flows sent on this channel only. Values: email, sms, push-notification, whatsapp
`flow_id`	id	No	This flow only.
`page_size`	number	No	Klaviyo pages this list by a size of its own. Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`flow_id` default	id	→ flows	-
`flow_message_id` default	id	—	-
`send_channel` default	string	—	-
`click_rate` default	number	—	-
`clicks_unique` default	number	—	-
`conversion_value` default	number	—	-
`conversions` default	number	—	-
`delivered` default	number	—	-
`open_rate` default	number	—	-
`opens_unique` default	number	—	-
`recipients` default	number	—	-
`unsubscribes` default	number	—	-

Metrics

The kinds of event the account records — Placed Order, Opened Email… — and the integration each comes from.

Used as filter by

Campaign Values Reports · conversion_metric_id

Events · metric_id

Flow Values Reports · conversion_metric_id

Read

Metrics

The kinds of event the account records — Placed Order, Opened Email… — and the integration each comes from.

Route: GET /metrics

Excel formula: =LF.klaviyo.metrics("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`integration_name`	string	No	The metrics of this integration only (Shopify, API…).
`integration_category`	string	No	The metrics of this kind of integration only.
`page_size`	number	No	Klaviyo pages this list by a size of its own. Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`created` default	date	—	-
`updated`	date	—	-
`integration`	string	—	-
`name` default	string	—	-
`category`	string	—	-

Audience

Add Profiles to List

Puts existing profiles on this list, by their ids. It changes no one’s consent: to subscribe a person, subscribe them.

Create

Add Profiles to List

Route: POST /mutation/listAddProfiles

Inputs you can set

Name	Type	Required	Description
`listId`	id	Yes	-
`profile_ids`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

List Profiles

The profiles on one list, with when each joined it.

Read

List Profiles

The profiles on one list, with when each joined it.

Route: GET /listProfiles

Excel formula: =LF.klaviyo.listProfiles("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`listId`	id	Yes	The list whose profiles to read.
`email`	string	No	The profile with exactly this email address.
`phone_number`	string	No	The profile with exactly this phone number, in E.164 format (+33612345678).
`joined_after`	string	No	Joined the group at or after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`joined_before`	string	No	Joined the group before this moment (ISO 8601, 2026-01-31T00:00:00Z).
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: joined_group_at, -joined_group_at
`page_size`	number	No	Rows per page (max 100). Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`email` default	string	—	-
`phone_number` default	string	—	-
`first_name` default	string	—	-
`last_name` default	string	—	-
`created` default	date	—	-

Lists

The account’s lists: the groups of profiles a campaign is sent to, each with its opt-in process.

Used as filter by

List Profiles · listId

Read

Lists

The account’s lists: the groups of profiles a campaign is sent to, each with its opt-in process.

Route: GET /lists

Excel formula: =LF.klaviyo.lists("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`name`	string	No	The list of exactly this name.
`ids`	string	No	These lists, their ids separated by commas.
`created_after`	string	No	Created after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`updated_after`	string	No	Updated after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: created, -created, id, -id, name
`page_size`	number	No	Rows per page (max 10). Default: 10
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`created` default	date	—	-
`updated`	date	—	-
`opt_in_process` default	enum	—	-

Create

Create List

Route: POST /mutation/lists

Inputs you can set

Name	Type	Required	Description
`name`	string	Yes	-
`opt_in_process`	enum	No	Values: double_opt_in, single_opt_in

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update List

Route: PATCH /mutation/lists

Inputs you can set

Name	Type	Required	Description
`name`	string	Yes	-
`opt_in_process`	enum	No	Values: double_opt_in, single_opt_in

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete List

Route: DELETE /mutation/lists

Inputs you can set

Name	Type	Required	Description
`name`	string	Yes	-
`opt_in_process`	enum	No	Values: double_opt_in, single_opt_in

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Profiles

The account’s profiles — the people it knows —, their location, custom properties and email and SMS consent.

Used as filter by

Coupon Codes · profile_id

Events · profile_id

Read

Profiles

The account’s profiles — the people it knows —, their location, custom properties and email and SMS consent.

Route: GET /profiles

Excel formula: =LF.klaviyo.profiles("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`email`	string	No	The profile with exactly this email address.
`phone_number`	string	No	The profile with exactly this phone number, in E.164 format (+33612345678).
`external_id`	string	No	The profile with exactly this external id.
`ids`	string	No	These profiles, their ids separated by commas.
`created_after`	string	No	Created after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`created_before`	string	No	Created before this moment (ISO 8601, 2026-01-31T00:00:00Z).
`updated_after`	string	No	Updated after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`updated_before`	string	No	Updated before this moment (ISO 8601, 2026-01-31T00:00:00Z).
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: created, -created, email, -email, id
`page_size`	number	No	Rows per page (max 100). Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`email` default	string	—	-
`phone_number` default	string	—	-
`first_name` default	string	—	-
`last_name` default	string	—	-
`created` default	date	—	-

Create

Create Profile

Route: POST /mutation/profiles

Inputs you can set

Name	Type	Required	Description
`email`	string	No	-
`external_id`	string	No	-
`first_name`	string	No	-
`image`	string	No	-
`last_name`	string	No	-
`locale`	string	No	-
`location.address1`	string	No	-
`location.address2`	string	No	-
`location.city`	string	No	-
`location.country`	string	No	-
`location.ip`	string	No	-
`location.latitude`	string	No	-
`location.longitude`	string	No	-
`location.region`	string	No	-
`location.timezone`	string	No	-
`location.zip`	string	No	-
`organization`	string	No	-
`phone_number`	string	No	-
`properties`	string	No	-
`title`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Profile

Route: PATCH /mutation/profiles

Inputs you can set

Name	Type	Required	Description
`email`	string	No	-
`external_id`	string	No	-
`first_name`	string	No	-
`image`	string	No	-
`last_name`	string	No	-
`locale`	string	No	-
`location.address1`	string	No	-
`location.address2`	string	No	-
`location.city`	string	No	-
`location.country`	string	No	-
`location.ip`	string	No	-
`location.latitude`	string	No	-
`location.longitude`	string	No	-
`location.region`	string	No	-
`location.timezone`	string	No	-
`location.zip`	string	No	-
`organization`	string	No	-
`phone_number`	string	No	-
`properties`	string	No	-
`title`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Remove Profiles from List

Takes profiles off a list: they stay in the account, and no one’s consent changes.

Create

Remove Profiles from List

Route: POST /mutation/listProfilesRemove

Inputs you can set

Name	Type	Required	Description
`listId`	id	Yes	-
`profile_ids`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Segment Profiles

The profiles in one segment, with when each joined it.

Read

Segment Profiles

The profiles in one segment, with when each joined it.

Route: GET /segmentProfiles

Excel formula: =LF.klaviyo.segmentProfiles("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`segmentId`	id	Yes	The segment whose profiles to read.
`email`	string	No	The profile with exactly this email address.
`phone_number`	string	No	The profile with exactly this phone number, in E.164 format (+33612345678).
`joined_after`	string	No	Joined the group at or after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`joined_before`	string	No	Joined the group before this moment (ISO 8601, 2026-01-31T00:00:00Z).
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: joined_group_at, -joined_group_at
`page_size`	number	No	Rows per page (max 100). Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`email` default	string	—	-
`phone_number` default	string	—	-
`first_name` default	string	—	-
`last_name` default	string	—	-
`created` default	date	—	-

Segments

The account’s segments: groups of profiles Klaviyo keeps up to date from the conditions that define them.

Used as filter by

Segment Profiles · segmentId

Read

Segments

The account’s segments: groups of profiles Klaviyo keeps up to date from the conditions that define them.

Route: GET /segments

Excel formula: =LF.klaviyo.segments("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`name`	string	No	The segment of exactly this name.
`ids`	string	No	These segments, their ids separated by commas.
`is_active`	boolean	No	Active segments only, or inactive ones only.
`is_starred`	boolean	No	Starred segments only, or the others only.
`created_after`	string	No	Created after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`updated_after`	string	No	Updated after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: created, -created, id, -id, name
`page_size`	number	No	Rows per page (max 10). Default: 10
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`definition`	string	—	-
`condition_groups`	string	—	-
`created` default	date	—	-
`updated`	date	—	-
`is_active` default	boolean	—	-
`is_processing`	boolean	—	-
`is_starred`	boolean	—	-

Create

Create Segment

Route: POST /mutation/segments

Inputs you can set

Name	Type	Required	Description
`definition.condition_groups`	string	Yes	-
`is_starred`	boolean	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Segment

Route: PATCH /mutation/segments

Inputs you can set

Name	Type	Required	Description
`definition.condition_groups`	string	Yes	-
`is_starred`	boolean	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Segment

Route: DELETE /mutation/segments

Inputs you can set

Name	Type	Required	Description
`definition.condition_groups`	string	Yes	-
`is_starred`	boolean	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Campaigns

Assign Template

Gives this message a copy of a template: later changes to the template do not reach it.

Create

Assign Template

Route: POST /mutation/campaignMessageAssignTemplate

Inputs you can set

Name	Type	Required	Description
`messageId`	id	Yes	-
`template_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Campaign Messages

The messages of one campaign: their channel, label, content and template.

Read

Campaign Messages

The messages of one campaign: their channel, label, content and template.

Route: GET /campaignMessages

Excel formula: =LF.klaviyo.campaignMessages("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`campaignId`	id	Yes	The campaign whose messages to read.
`page_size`	number	No	Klaviyo pages this list by a size of its own. Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`campaign_id` default	id	—	-
`definition`	string	—	-
`channel` default	string	—	-
`label` default	string	—	-
`content`	string	—	-
`template_id`	id	—	-
`template`	string	—	-
`name`	string	—	-
`send_times`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Campaigns

The account’s campaigns — one channel each, email by default —, their audiences, send strategy, status and send time.

Used as filter by

Campaign Messages · campaignId

Campaign Values Reports · campaign_id

Read

Campaigns

The account’s campaigns — one channel each, email by default —, their audiences, send strategy, status and send time.

Route: GET /campaigns

Excel formula: =LF.klaviyo.campaigns("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`channel`	enum	No	The campaigns of this channel: Klaviyo lists one channel at a time, email when none is named. Default: email Values: email, sms, mobile_push
`name_contains`	string	No	The campaigns whose name holds this text.
`status`	enum	No	The campaigns in this status. Values: Draft, Scheduled, Sending, Sent, Cancelled
`archived`	boolean	No	Archived campaigns only, or the others only.
`created_from`	string	No	Created at or after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`created_to`	string	No	Created before this moment (ISO 8601, 2026-01-31T00:00:00Z).
`updated_from`	string	No	Updated at or after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`updated_to`	string	No	Updated before this moment (ISO 8601, 2026-01-31T00:00:00Z).
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: created_at, -created_at, id, -id, name
`page_size`	number	No	Rows per page (max 100). Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`status` default	enum	—	-
`archived`	boolean	—	-
`audiences`	string	—	-
`included`	string[]	—	-
`excluded`	string[]	—	-
`created_at` default	date	—	-
`scheduled_at`	date	—	-
`updated_at`	date	—	-
`send_time` default	date	—	-
`send_strategy`	string	—	-
`method`	string	—	-
`datetime`	date	—	-
`send_options`	string	—	-
`use_smart_sending`	boolean	—	-
`tracking_options`	string	—	-
`is_tracking_opens`	boolean	—	-
`is_tracking_clicks`	boolean	—	-
`campaign_message_ids`	string[]	—	-
`tag_ids`	string[]	—	-
`can_send`	boolean	—	-
`can_cancel`	boolean	—	-

Create

Create Campaign

Route: POST /mutation/campaigns

Inputs you can set

Name	Type	Required	Description
`audiences.excluded`	string	No	-
`audiences.included`	string	Yes	-
`channel`	enum	No	Values: email, sms
`message.body`	string	No	-
`message.from_email`	string	No	-
`message.from_label`	string	No	-
`message.label`	string	No	-
`message.preview_text`	string	No	-
`message.reply_to_email`	string	No	-
`message.subject`	string	No	-
`name`	string	Yes	-
`send_options.use_smart_sending`	boolean	No	-
`send_strategy.date`	string	No	-
`send_strategy.datetime`	string	No	-
`send_strategy.method`	enum	No	Values: immediate, static, throttled, smart_send_time
`send_strategy.throttle_percentage`	number	No	-
`tracking_options.is_tracking_clicks`	boolean	No	-
`tracking_options.is_tracking_opens`	boolean	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Campaign

Route: PATCH /mutation/campaigns

Inputs you can set

Name	Type	Required	Description
`audiences.excluded`	string	No	-
`audiences.included`	string	Yes	-
`channel`	enum	No	Values: email, sms
`message.body`	string	No	-
`message.from_email`	string	No	-
`message.from_label`	string	No	-
`message.label`	string	No	-
`message.preview_text`	string	No	-
`message.reply_to_email`	string	No	-
`message.subject`	string	No	-
`name`	string	Yes	-
`send_options.use_smart_sending`	boolean	No	-
`send_strategy.date`	string	No	-
`send_strategy.datetime`	string	No	-
`send_strategy.method`	enum	No	Values: immediate, static, throttled, smart_send_time
`send_strategy.throttle_percentage`	number	No	-
`tracking_options.is_tracking_clicks`	boolean	No	-
`tracking_options.is_tracking_opens`	boolean	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Campaign

Route: DELETE /mutation/campaigns

Inputs you can set

Name	Type	Required	Description
`audiences.excluded`	string	No	-
`audiences.included`	string	Yes	-
`channel`	enum	No	Values: email, sms
`message.body`	string	No	-
`message.from_email`	string	No	-
`message.from_label`	string	No	-
`message.label`	string	No	-
`message.preview_text`	string	No	-
`message.reply_to_email`	string	No	-
`message.subject`	string	No	-
`name`	string	Yes	-
`send_options.use_smart_sending`	boolean	No	-
`send_strategy.date`	string	No	-
`send_strategy.datetime`	string	No	-
`send_strategy.method`	enum	No	Values: immediate, static, throttled, smart_send_time
`send_strategy.throttle_percentage`	number	No	-
`tracking_options.is_tracking_clicks`	boolean	No	-
`tracking_options.is_tracking_opens`	boolean	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Cancel Campaign Send

Stops a campaign whose send is under way: cancel stops it for good, revert puts it back to draft.

Create

Cancel Campaign Send

Route: POST /mutation/campaignCancelSend

Inputs you can set

Name	Type	Required	Description
`action`	enum	Yes	Values: cancel, revert
`campaignId`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Clone Campaign

Copies this campaign into a new draft.

Create

Clone Campaign

Route: POST /mutation/campaignClone

Inputs you can set

Name	Type	Required	Description
`campaignId`	id	Yes	-
`new_name`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Send Campaign

Sends this draft campaign by its send strategy — at once, or at the date it names — to every recipient of its audiences. It cannot be recalled.

Create

Send Campaign

Route: POST /mutation/campaignSend

Inputs you can set

Name	Type	Required	Description
`campaignId`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Catalog

Catalog Categories

The categories of the account’s own catalog.

Used as filter by

Catalog Items · category_id

Read

Catalog Categories

The categories of the account’s own catalog.

Route: GET /catalogCategories

Excel formula: =LF.klaviyo.catalogCategories("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`ids`	string	No	These categories, their ids separated by commas.
`item_id`	id	No	The categories of this item only.
`name_contains`	string	No	The categories whose name holds this text.
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: created, -created
`page_size`	number	No	Rows per page (max 100). Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`external_id` default	string	—	-
`name` default	string	—	-
`updated` default	date	—	-

Create

Create Catalog Category

Route: POST /mutation/catalogCategories

Inputs you can set

Name	Type	Required	Description
`external_id`	string	Yes	-
`item_ids`	string	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Catalog Category

Route: PATCH /mutation/catalogCategories

Inputs you can set

Name	Type	Required	Description
`external_id`	string	Yes	-
`item_ids`	string	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Catalog Category

Route: DELETE /mutation/catalogCategories

Inputs you can set

Name	Type	Required	Description
`external_id`	string	Yes	-
`item_ids`	string	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Catalog Items

The items of the account’s own catalog ($custom), as its messages and product feeds show them. An item synced by a store’s integration is changed in the store.

Used as filter by

Catalog Categories · item_id

Catalog Variants · item_id

Read

Catalog Items

The items of the account’s own catalog ($custom), as its messages and product feeds show them. An item synced by a store’s integration is changed in the store.

Route: GET /catalogItems

Excel formula: =LF.klaviyo.catalogItems("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`ids`	string	No	These items, their ids separated by commas.
`category_id`	id	No	The items of this category only.
`title_contains`	string	No	The items whose title holds this text.
`published`	boolean	No	Published items only, or the others only.
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: created, -created
`page_size`	number	No	Rows per page (max 100). Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`external_id` default	string	—	-
`title` default	string	—	-
`price` default	number	—	-
`published` default	boolean	—	-
`updated` default	date	—	-

Create

Create Catalog Item

Route: POST /mutation/catalogItems

Inputs you can set

Name	Type	Required	Description
`category_ids`	string	No	-
`custom_metadata`	string	No	-
`description`	string	Yes	-
`external_id`	string	Yes	-
`image_full_url`	string	No	-
`image_thumbnail_url`	string	No	-
`images`	string	No	-
`price`	number	No	-
`published`	boolean	No	-
`title`	string	Yes	-
`url`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Catalog Item

Route: PATCH /mutation/catalogItems

Inputs you can set

Name	Type	Required	Description
`category_ids`	string	No	-
`custom_metadata`	string	No	-
`description`	string	Yes	-
`external_id`	string	Yes	-
`image_full_url`	string	No	-
`image_thumbnail_url`	string	No	-
`images`	string	No	-
`price`	number	No	-
`published`	boolean	No	-
`title`	string	Yes	-
`url`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Catalog Item

Route: DELETE /mutation/catalogItems

Inputs you can set

Name	Type	Required	Description
`category_ids`	string	No	-
`custom_metadata`	string	No	-
`description`	string	Yes	-
`external_id`	string	Yes	-
`image_full_url`	string	No	-
`image_thumbnail_url`	string	No	-
`images`	string	No	-
`price`	number	No	-
`published`	boolean	No	-
`title`	string	Yes	-
`url`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Catalog Variants

The variants of the account’s own catalog items: their SKU, price and stock, as its messages show them.

Read

Catalog Variants

The variants of the account’s own catalog items: their SKU, price and stock, as its messages show them.

Route: GET /catalogVariants

Excel formula: =LF.klaviyo.catalogVariants("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`ids`	string	No	These variants, their ids separated by commas.
`item_id`	id	No	The variants of this item only.
`sku`	string	No	The variant of exactly this SKU.
`title_contains`	string	No	The variants whose title holds this text.
`published`	boolean	No	Published variants only, or the others only.
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: created, -created
`page_size`	number	No	Rows per page (max 100). Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`title` default	string	—	-
`sku` default	string	—	-
`inventory_quantity` default	number	—	-
`price` default	number	—	-
`updated` default	date	—	-
`item_id` default	id	→ catalogItems	-

Create

Create Catalog Variant

Route: POST /mutation/catalogVariants

Inputs you can set

Name	Type	Required	Description
`custom_metadata`	string	No	-
`description`	string	Yes	-
`external_id`	string	Yes	-
`image_full_url`	string	No	-
`image_thumbnail_url`	string	No	-
`images`	string	No	-
`inventory_policy`	enum	No	Values: 0, 1, 2
`inventory_quantity`	number	Yes	-
`item_id`	id	Yes	-
`price`	number	Yes	-
`published`	boolean	No	-
`sku`	string	Yes	-
`title`	string	Yes	-
`url`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Catalog Variant

Route: PATCH /mutation/catalogVariants

Inputs you can set

Name	Type	Required	Description
`custom_metadata`	string	No	-
`description`	string	Yes	-
`external_id`	string	Yes	-
`image_full_url`	string	No	-
`image_thumbnail_url`	string	No	-
`images`	string	No	-
`inventory_policy`	enum	No	Values: 0, 1, 2
`inventory_quantity`	number	Yes	-
`item_id`	id	Yes	-
`price`	number	Yes	-
`published`	boolean	No	-
`sku`	string	Yes	-
`title`	string	Yes	-
`url`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Catalog Variant

Route: DELETE /mutation/catalogVariants

Inputs you can set

Name	Type	Required	Description
`custom_metadata`	string	No	-
`description`	string	Yes	-
`external_id`	string	Yes	-
`image_full_url`	string	No	-
`image_thumbnail_url`	string	No	-
`images`	string	No	-
`inventory_policy`	enum	No	Values: 0, 1, 2
`inventory_quantity`	number	Yes	-
`item_id`	id	Yes	-
`price`	number	Yes	-
`published`	boolean	No	-
`sku`	string	Yes	-
`title`	string	Yes	-
`url`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Consent

Profile Suppressions

The jobs that suppressed profiles — a suppressed profile receives no email marketing, whatever its consent —, and a person suppressed by their email.

Read

Profile Suppressions

The jobs that suppressed profiles — a suppressed profile receives no email marketing, whatever its consent —, and a person suppressed by their email.

Route: GET /profileSuppressions

Excel formula: =LF.klaviyo.profileSuppressions("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`status`	enum	No	The jobs in this status. Values: queued, processing, complete, cancelled
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: created, -created
`page_size`	number	No	Klaviyo pages this list by a size of its own. Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`status` default	enum	—	-
`created_at` default	date	—	-
`total_count` default	number	—	-
`completed_count` default	number	—	-
`completed_at`	date	—	-
`skipped_count`	number	—	-

Create

Suppress Profile

Route: POST /mutation/profileSuppressions

Inputs you can set

Name	Type	Required	Description
`email`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Profile Unsuppressions

The jobs that lifted suppressions a person asked for (USER_SUPPRESSED), and one lifted by their email. An unsubscribe or a bounce is never lifted.

Read

Profile Unsuppressions

The jobs that lifted suppressions a person asked for (USER_SUPPRESSED), and one lifted by their email. An unsubscribe or a bounce is never lifted.

Route: GET /profileUnsuppressions

Excel formula: =LF.klaviyo.profileUnsuppressions("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`status`	enum	No	The jobs in this status. Values: queued, processing, complete, cancelled
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: created, -created
`page_size`	number	No	Klaviyo pages this list by a size of its own. Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`status` default	enum	—	-
`created_at` default	date	—	-
`total_count` default	number	—	-
`completed_count` default	number	—	-
`completed_at`	date	—	-
`skipped_count`	number	—	-

Create

Unsuppress Profile

Route: POST /mutation/profileUnsuppressions

Inputs you can set

Name	Type	Required	Description
`email`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Request Profile Deletion

Erases one person and everything Klaviyo holds of them, at their request (GDPR, CCPA): for good, in the background.

Create

Request Profile Deletion

Route: POST /mutation/dataPrivacyDeletions

Inputs you can set

Name	Type	Required	Description
`email`	string	No	-
`phone_number`	string	No	-
`profile_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Subscribe Profile

Subscribes one person to email (and SMS) marketing with their consent, on a list when one is named. On a list with double opt-in, Klaviyo first emails them to confirm. Klaviyo applies it in the background.

Create

Subscribe Profile

Route: POST /mutation/profileSubscriptions

Inputs you can set

Name	Type	Required	Description
`custom_source`	string	No	-
`email`	string	No	-
`email_marketing`	boolean	No	-
`list_id`	id	No	-
`phone_number`	string	No	-
`sms_marketing`	boolean	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Unsubscribe Profile

Unsubscribes one person from email (and SMS) marketing. With a list named, Klaviyo unsubscribes them everywhere when they are not on it. Klaviyo applies it in the background.

Create

Unsubscribe Profile

Route: POST /mutation/profileUnsubscriptions

Inputs you can set

Name	Type	Required	Description
`email`	string	No	-
`email_marketing`	boolean	No	-
`list_id`	id	No	-
`phone_number`	string	No	-
`sms_marketing`	boolean	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Content

Clone Template

Copies this template into a new one.

Create

Clone Template

Route: POST /mutation/templateClone

Inputs you can set

Name	Type	Required	Description
`name`	string	No	-
`templateId`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Forms

The account’s sign-up forms: their status and whether they run an A/B test. They are designed in Klaviyo.

Read

Forms

The account’s sign-up forms: their status and whether they run an A/B test. They are designed in Klaviyo.

Route: GET /forms

Excel formula: =LF.klaviyo.forms("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`name_contains`	string	No	The forms whose name holds this text.
`status`	enum	No	The forms in this status. Values: draft, live
`ab_test`	boolean	No	The forms with an A/B test only, or the others only.
`updated_from`	string	No	Updated at or after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`updated_to`	string	No	Updated before this moment (ISO 8601, 2026-01-31T00:00:00Z).
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: created_at, -created_at, updated_at, -updated_at
`page_size`	number	No	Rows per page (max 100). Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`status` default	enum	—	-
`ab_test`	boolean	—	-
`created_at`	date	—	-
`updated_at` default	date	—	-

Templates

The account’s email templates: their name, editor and plain text. Their HTML is edited in Klaviyo, and never read into a row.

Read

Templates

The account’s email templates: their name, editor and plain text. Their HTML is edited in Klaviyo, and never read into a row.

Route: GET /templates

Excel formula: =LF.klaviyo.templates("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`name`	string	No	The template of exactly this name.
`name_contains`	string	No	The templates whose name holds this text.
`updated_from`	string	No	Updated at or after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`updated_to`	string	No	Updated before this moment (ISO 8601, 2026-01-31T00:00:00Z).
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: created, -created, id, -id, name
`page_size`	number	No	Rows per page (max 10). Default: 10
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`editor_type` default	string	—	-
`text`	string	—	-
`created`	date	—	-
`updated` default	date	—	-

Create

Create Template

Route: POST /mutation/templates

Inputs you can set

Name	Type	Required	Description
`editor_type`	enum	Yes	Values: CODE, USER_DRAGGABLE
`html`	string	Yes	-
`name`	string	Yes	-
`text`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Template

Route: PATCH /mutation/templates

Inputs you can set

Name	Type	Required	Description
`editor_type`	enum	Yes	Values: CODE, USER_DRAGGABLE
`html`	string	Yes	-
`name`	string	Yes	-
`text`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Template

Route: DELETE /mutation/templates

Inputs you can set

Name	Type	Required	Description
`editor_type`	enum	Yes	Values: CODE, USER_DRAGGABLE
`html`	string	Yes	-
`name`	string	Yes	-
`text`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Coupons

Coupon Codes

The codes of a coupon, or those handed to a profile: their status and expiry. Klaviyo lists them by coupon or by profile.

Read

Coupon Codes

The codes of a coupon, or those handed to a profile: their status and expiry. Klaviyo lists them by coupon or by profile.

Route: GET /couponCodes

Excel formula: =LF.klaviyo.couponCodes("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`coupon_id`	id	No	The codes of this coupon. Klaviyo needs a coupon or a profile.
`profile_id`	id	No	The codes handed to this profile. Klaviyo needs a coupon or a profile.
`status`	enum	No	The codes in this status. Values: UNASSIGNED, PROCESSING, ASSIGNED_TO_PROFILE, VERSION_NOT_ACTIVE, DELETING
`expires_from`	string	No	Expiring at or after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`expires_to`	string	No	Expiring before this moment (ISO 8601, 2026-01-31T00:00:00Z).
`page_size`	number	No	Rows per page (max 100). Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`unique_code` default	string	—	-
`expires_at` default	date	—	-
`status` default	enum	—	-
`coupon_id` default	id	—	-
`coupon`	string	—	-
`external_id`	string	—	-
`profile_id`	id	—	-

Create

Create Coupon Code

Route: POST /mutation/couponCodes

Inputs you can set

Name	Type	Required	Description
`coupon_id`	id	Yes	-
`expires_at`	string	No	-
`unique_code`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Coupon Code

Route: PATCH /mutation/couponCodes

Inputs you can set

Name	Type	Required	Description
`coupon_id`	id	Yes	-
`expires_at`	string	No	-
`unique_code`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Coupon Code

Route: DELETE /mutation/couponCodes

Inputs you can set

Name	Type	Required	Description
`coupon_id`	id	Yes	-
`expires_at`	string	No	-
`unique_code`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Coupons

The account’s coupons — each a discount of a store, by its id there —, and how Klaviyo hands out their codes.

Used as filter by

Coupon Codes · coupon_id

Read

Coupons

The account’s coupons — each a discount of a store, by its id there —, and how Klaviyo hands out their codes.

Route: GET /coupons

Excel formula: =LF.klaviyo.coupons("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`page_size`	number	No	Rows per page (max 100). Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`external_id` default	string	—	-
`description` default	string	—	-
`monitor_configuration`	string	—	-
`assigner_configuration`	string	—	-
`used`	enum	—	-
`unused_expired`	enum	—	-

Create

Create Coupon

Route: POST /mutation/coupons

Inputs you can set

Name	Type	Required	Description
`assigner_configuration.unused_expired`	enum	No	Values: ALWAYS_ASSIGN, NEVER_ASSIGN
`assigner_configuration.used`	enum	No	Values: ALWAYS_ASSIGN, ASSIGN_IF_EXPIRED, NEVER_ASSIGN
`description`	string	No	-
`external_id`	string	Yes	-
`monitor_configuration`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Coupon

Route: PATCH /mutation/coupons

Inputs you can set

Name	Type	Required	Description
`assigner_configuration.unused_expired`	enum	No	Values: ALWAYS_ASSIGN, NEVER_ASSIGN
`assigner_configuration.used`	enum	No	Values: ALWAYS_ASSIGN, ASSIGN_IF_EXPIRED, NEVER_ASSIGN
`description`	string	No	-
`external_id`	string	Yes	-
`monitor_configuration`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Coupon

Route: DELETE /mutation/coupons

Inputs you can set

Name	Type	Required	Description
`assigner_configuration.unused_expired`	enum	No	Values: ALWAYS_ASSIGN, NEVER_ASSIGN
`assigner_configuration.used`	enum	No	Values: ALWAYS_ASSIGN, ASSIGN_IF_EXPIRED, NEVER_ASSIGN
`description`	string	No	-
`external_id`	string	Yes	-
`monitor_configuration`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Flows

Flow Actions

The steps of one flow — a message sent, a delay, a split —, each as Klaviyo defines it.

Read

Flow Actions

The steps of one flow — a message sent, a delay, a split —, each as Klaviyo defines it.

Route: GET /flowActions

Excel formula: =LF.klaviyo.flowActions("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`flowId`	id	Yes	The flow whose actions to read.
`action_type`	string	No	The actions of this type only (SEND_EMAIL, TIME_DELAY…).
`status`	string	No	The actions in this status only.
`page_size`	number	No	Rows per page (max 50). Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`flow_id` default	id	—	-
`definition` default	string	—	-
`flow_message_ids`	string[]	—	-
`created` default	date	—	-
`updated`	date	—	-

Flows

The account’s flows: the automations that message profiles on their own, from a trigger (a list joined, a metric, a date).

Used as filter by

Flow Actions · flowId

Flow Values Reports · flow_id

Read

Flows

The account’s flows: the automations that message profiles on their own, from a trigger (a list joined, a metric, a date).

Route: GET /flows

Excel formula: =LF.klaviyo.flows("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`name_contains`	string	No	The flows whose name holds this text.
`status`	enum	No	The flows in this status. Values: draft, manual, live
`archived`	boolean	No	Archived flows only, or the others only.
`trigger_type`	enum	No	The flows of this trigger. Values: Added to List, Date Based, Low Inventory, Metric, Price Drop
`updated_from`	string	No	Updated at or after this moment (ISO 8601, 2026-01-31T00:00:00Z).
`updated_to`	string	No	Updated before this moment (ISO 8601, 2026-01-31T00:00:00Z).
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: created, -created, id, -id, name
`page_size`	number	No	Rows per page (max 50). Default: 50
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`status` default	string	—	-
`archived`	boolean	—	-
`created`	date	—	-
`updated` default	date	—	-
`trigger_type` default	enum	—	-
`tag_ids`	string[]	—	-

Edit

Change Flow Status

Route: PATCH /mutation/flows

Inputs you can set

Name	Type	Required	Description
`status`	enum	Yes	Values: draft, manual, live

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Flow

Route: DELETE /mutation/flows

Inputs you can set

Name	Type	Required	Description
`status`	enum	Yes	Values: draft, manual, live

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Tags

Tag Groups

The groups of tags: an exclusive group lets a record carry one of its tags at most.

Read

Tag Groups

The groups of tags: an exclusive group lets a record carry one of its tags at most.

Route: GET /tagGroups

Excel formula: =LF.klaviyo.tagGroups("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Klaviyo’s refusal.
`name_contains`	string	No	The groups whose name holds this text.
`exclusive`	boolean	No	Exclusive groups only, or the others only.
`sort`	enum	No	The order of the rows: a field, oldest or lowest first; - before it for the latest or highest first. Values: id, -id, name, -name
`page_size`	number	No	Rows per page (max 25). Default: 25
`cursor`	string	No	The cursor the previous page answered: empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`exclusive` default	boolean	—	-
`default` default	boolean	—	-

Create

Create Tag Group

Route: POST /mutation/tagGroups

Inputs you can set

Name	Type	Required	Description
`exclusive`	boolean	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Tag Group

Route: PATCH /mutation/tagGroups

Inputs you can set

Name	Type	Required	Description
`exclusive`	boolean	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Tag Group

Route: DELETE /mutation/tagGroups

Inputs you can set

Name	Type	Required	Description
`exclusive`	boolean	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Tags

The tags that sort the account’s campaigns, flows, lists and segments, each in its tag group.

Read

Create Tag

Route: POST /mutation/tags

Inputs you can set

Name	Type	Required	Description
`name`	string	Yes	-
`tag_group_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Tag

Route: PATCH /mutation/tags

Inputs you can set

Name	Type	Required	Description
`name`	string	Yes	-
`tag_group_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Tag

Route: DELETE /mutation/tags

Inputs you can set

Name	Type	Required	Description
`name`	string	Yes	-
`tag_group_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

← PreviousKlaviyo audience and campaigns Next →LinkyFlow for Brevo