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.

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

Destructive Klaviyo operations are blocked at the CLI level. Klaviyo's DELETE endpoints for profiles, lists, segments, campaigns, and flows are not reachable through this tool, even via the raw api passthrough. Only template deletion is allowlisted (transport.py, DELETE_ALLOWED_PATHS). This is why it's safe to hand klaviyo-cli to an agent with a live API key: the agent can read anything and change campaign content, timing, and audiences, but it cannot delete subscriber data, segments, or send history. One command can stop mail going to real people: suppress. It deletes nothing, but because it halts sends it requires an explicit --yes flag or an interactive confirmation before it runs.

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
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
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
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)
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

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)
form-performance Show pop-up/form views, submits, and submit rates

SMS

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

Raw API

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

That's 32 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

klaviyo_cli-0.3.0.tar.gz (54.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

klaviyo_cli-0.3.0-py3-none-any.whl (41.4 kB view details)

Uploaded Python 3

File details

Details for the file klaviyo_cli-0.3.0.tar.gz.

File metadata

  • Download URL: klaviyo_cli-0.3.0.tar.gz
  • Upload date:
  • Size: 54.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for klaviyo_cli-0.3.0.tar.gz
Algorithm Hash digest
SHA256 ac404040a2174fa6d99624d4877b96580a061b6be36833b2a9af40a8e9e46b72
MD5 c1addf3832a4f0edb89922876d02df38
BLAKE2b-256 23df93724e39e2f2c10e952104df922169b863af0109d7bcaad5a1350bf36347

See more details on using hashes here.

Provenance

The following attestation bundles were made for klaviyo_cli-0.3.0.tar.gz:

Publisher: publish.yml on BeauchampAndrew/klaviyo-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file klaviyo_cli-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: klaviyo_cli-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 41.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for klaviyo_cli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fa1a48a2396fa5f323bc34e4ef322854ec0cf8ed4b45fafcd477212f88407a1b
MD5 ccb1c4699fc068620f8b81669e6b6af5
BLAKE2b-256 eb69d6d495b9645854e207f2dfee376d9222db5e6616f7568102db593e45b8fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for klaviyo_cli-0.3.0-py3-none-any.whl:

Publisher: publish.yml on BeauchampAndrew/klaviyo-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page