Skip to main content

klaviyo-cli

A command-line interface for Klaviyo: campaigns, segments, flows, metrics, and scheduling. Built for humans and AI agents.

uvx --from klaviyo-cli klaviyo --help

No install needed. Or install it: pipx install klaviyo-cli or uv tool install klaviyo-cli. Requires Python 3.11+.

Built and maintained by BS&Co, a retention marketing agency for eCommerce brands. Read why we built it and how we made it safe to hand to AI agents: https://bsandco.us/blog-post/klaviyo-cli

Unofficial. Not affiliated with, endorsed, or supported by Klaviyo, Inc.

Quickstart

export KLAVIYO_API_KEY=pk_...

Get a private API key from Klaviyo under Settings > API Keys. Read commands need read scopes; commands that change data (patch, schedule, create, upload) need write scopes.

klaviyo list-campaigns --days 30
klaviyo account-health

Using with Claude Code and AI agents

--json is a global flag: put it before the command name for machine-readable output on any command:

klaviyo --json list-campaigns --days 30

Deletes are gated. The raw api passthrough can only delete templates (transport.py, DELETE_ALLOWED_PATHS). Segments, lists, campaigns, and flows can only be deleted with klaviyo delete <type> <id>, which prints what it is about to remove (profile count, status, and for segments and lists every flow and draft/scheduled campaign still using it), then requires the ID typed back, or --confirm <id> in a non-interactive shell. Without that confirmation nothing is deleted. Profiles cannot be deleted through this tool. Two commands can stop mail going to real people, and both require an explicit --yes flag or an interactive confirmation before they run: suppress (reversible — unsuppress undoes it) and unsubscribe (it revokes consent, which unsuppress cannot undo; reversing it takes a deliberate call to Klaviyo's bulk subscribe endpoint asserting fresh consent, which this CLI intentionally does not wrap).

Drop this in your repo's CLAUDE.md so an agent knows the tool exists:

## Klaviyo
Use the `klaviyo` CLI for Klaviyo data and actions (campaigns, segments,
flows, metrics). Auth via KLAVIYO_API_KEY env var. Pass --json before the
command for machine-readable output (e.g. `klaviyo --json list-campaigns`).
Run `klaviyo --help` for the full command list.

Command reference

Run klaviyo COMMAND --help for full options on any command.

Campaigns

Command Description
list-campaigns List/filter campaigns by status, channel, and date (beyond name search)
search-campaigns Search campaigns by name
get-campaign Show details for a specific campaign, incl. subject/preview and planned send time; --names resolves audience IDs
get-creative Dump a campaign's creative (subject + text/HTML) via its template
list-drafts List draft email campaigns for a client
patch-campaign Update campaign send time and/or audiences
patch-message Change subject, preview text or sender without dropping the other fields (Klaviyo replaces the whole content object); verifies after
clone-campaign Duplicate a campaign into a new draft and print what it inherited (subject, from address, audiences) plus message/template ids
set-campaign-html Replace a campaign's HTML from a file and verify the live creative (--expect/--forbid text checks)
schedule Schedule a campaign for sending
campaign-performance Show campaign revenue and engagement metrics
metrics Show sent campaigns for a client within a date window

Segments

Command Description
list-audiences List all lists and segments for a client
search-segments Find segments by name keyword; shows a one-line definition summary
get-segment Show a segment's definition (conditions, metric IDs resolved) + count
segment-count Get profile count for a single segment (rate limited: 1/s, 15/min)
segment-sizes Show all segments with profile counts
list-sizes Show all lists with profile counts, newest first
create-segment Create a segment from a definition, guarding against duplicates

Flows

Command Description
flows List all flows for a client, with optional sort and name search
get-flow Show a flow's basics in one call; --definition renders the branch tree (splits, messages, delays)
flow-detail Show full flow structure: trigger, filters, emails with subjects, delays, splits
flow-performance Show flow revenue and engagement metrics
flow-series Flow performance over time (daily/weekly/monthly buckets, per flow or per message)
flow-actions List a flow's actions with status and created/updated timestamps (audit view)
create-flow Create a flow (in draft) from a definition, guarding against duplicates

Profiles

Command Description
get-profile Look up a profile by email or ID; --subscriptions adds consent state and suppressions
segment-members List profiles in a segment: email, name, and when they joined
suppress Suppress profiles from email marketing in bulk (requires --yes or confirmation)
unsuppress Remove manual suppressions in bulk (never resubscribes anyone)
unsubscribe Set email consent to UNSUBSCRIBED in bulk — unsuppress can't undo it; --list scopes to one list (requires --yes or confirmation)
suppression-jobs List bulk suppression jobs (suppress + unsuppress) with status and counts

Events

Command Description
push-event Push a custom event to a profile by email (creates the profile if needed)
events List recent events for a metric ID; --since/--until windows, --properties payloads; warns when --limit cuts the window
export-events Bulk-export ALL events for a metric in a window as NDJSON (exhaustive pagination; --out file, --fields, --max-pages guard)

Metrics

Command Description
account-health Show profiles count, lists, and metrics for a client
list-metrics List event metrics with their IDs and integration (ID<->name catalog)
metric-aggregate Bucketed counts for one metric over time (hour/day/week/month, optional group-by)
forms List sign-up forms with live/draft status and dates, newest first (--status, --versions)
form-performance Show pop-up/form views, submits, and submit rates

Forms

Uses Forms API revision 2026-10-15 (needs forms:read, plus forms:write to edit). The API only edits draft versions: live versions are echoed back unchanged, versions can't be added or removed, and every edit stays in draft until published. A/B-tested forms and forms with no display triggers have to be handled in the form editor.

Command Description
form Show a form's versions, triggers, and every block's text step by step; --out saves the full definition JSON for editing
form-replace Find/replace any text (copy, labels, URLs) in the draft version(s); --dry-run shows each change; verifies by reading back. Never touches the live version
update-form Save an edited form --out file back as the definition; live versions are restored from the server and version IDs must match
copy-form Create a new draft form from one version of an existing form (--version, default the live one)
publish-form Publish the draft over the live version; requires the form ID typed back or --confirm <id>
unpublish-form Take a form off the site; same confirmation

SMS

Command Description
upload-sms Create an SMS campaign draft in Klaviyo

Images

Command Description
upload-image Upload a local image to the image library and print its hosted URL (multipart; needs a direct API key)

Delete

Command Description
delete Permanently delete a segment, list, campaign, or flow: klaviyo delete <type> <id>. Shows what uses it first, then requires the ID typed back or --confirm <id>

Raw API

Command Description
api Raw API pass-through: klaviyo api <METHOD> <path>

That's 50 commands total.

Multi-account profiles

For managing more than one Klaviyo account, put credentials in ~/.config/klaviyo-cli/config.toml:

default_profile = "acme"

[profiles.acme]
api_key = "pk_acme_..."

[profiles.other-brand]
api_key = "pk_other_..."

Select a profile with --profile (or -p), or set KLAVIYO_PROFILE:

klaviyo --profile other-brand account-health
KLAVIYO_PROFILE=other-brand klaviyo account-health

Precedence: an explicit --profile (or KLAVIYO_PROFILE) wins first. Otherwise KLAVIYO_API_KEY is used if set. Otherwise the CLI falls back to default_profile in the config file.

Agencies running the CLI across many clients can go further and embed it: re-expose every command under a host CLI with per-client auth resolution, so yourcli campaign-performance acme --days 30 resolves credentials for acme before the call. See the wrap_with_account and build_host_group docstrings in src/klaviyo_cli/embed.py.

License

MIT. See LICENSE.

Built and maintained by BS&Co, a retention marketing agency for eCommerce brands.

Metadata

Release files for klaviyo-cli 0.10.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for klaviyo-cli 0.10.4
File Size Uploaded Provenance
klaviyo_cli-0.10.4.tar.gz 77.2 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for klaviyo-cli 0.10.4
File Interpreter ABI Platform
klaviyo_cli-0.10.4-py3-none-any.whl Python 3 none any Details

Total release size: 134.8 kB

Release files / klaviyo_cli-0.10.4.tar.gz

Download URL klaviyo_cli-0.10.4.tar.gz
Size 77.2 kB
Tags Source
SHA-256 checksum
How to use checksums
5a2e5575edd66f39f97cb95b06a3407946bc1157d01781b3ce8438af48a758ad
BLAKE2b-256 checksum
How to use checksums
5189867e46de3a1c0aeb2f9fcc67520ff590f4dfe799511ecfadd0093dfe11a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.

Transparency log

Release files / klaviyo_cli-0.10.4-py3-none-any.whl

Download URL klaviyo_cli-0.10.4-py3-none-any.whl
Size 57.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2c68ef236e8d46063e8e271f5b13b06b4ff0fb8f7fe593ea4474096073c2881f
BLAKE2b-256 checksum
How to use checksums
b2706c9ac020c330b980db263a49f5c0e41bc91284ae97795973dd21645ab69c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.

Transparency log

Security for klaviyo-cli 0.10.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for klaviyo_cli-0.10.4.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page