Documentation

Klaviyo CLI

klaviyo-pp-cli

Install

$ npx -y @mvanhorn/printing-press-library install klaviyo

Installs the CLI binary and the agent skill for Claude Code, Codex, Cursor, Gemini CLI, Copilot, and more. Add --cli-only or --skill-only for one half. Requires Node.

Documentation

Klaviyo from the shell, with local customer-behavior analytics layered on top.

This printed CLI wraps Klaviyo's JSON:API surface for profiles, events, campaigns, flows, segments, metrics, templates, and related marketing resources. It adds a local SQLite mirror plus compound commands for campaign deployment, flow decay, attribution, deduplication, reconciliation, and growth planning.

Learn more at Klaviyo.

Created by @cathrynlavery (Cathryn Lavery).

Authentication

Set KLAVIYO_API_KEY to a private Klaviyo API key. Requests send Authorization: Klaviyo-API-Key and use the revision pinned by the generated OpenAPI spec.

Quick Start

# Check that KLAVIYO_API_KEY is present and accepted.
klaviyo-pp-cli auth doctor

# Fetch one profile and keep the response small for agents.
klaviyo-pp-cli profiles list --limit 1 --json --select data.id,data.email

# Populate local metric data for search and analytics.
klaviyo-pp-cli sync metrics

# Use the local mirror for a compound revenue view.
klaviyo-pp-cli attribution --metric "Placed Order" --group-by flow --since 2026-01-01 --json

Unique Features

These capabilities aren't available in any other tool for this API.

Campaign operations

campaigns deploy — Create an email template, create a draft campaign, and assign the template to the campaign message in one audited workflow.

Agents can build a draft campaign without hand-stitching three endpoint calls.
```
klaviyo-pp-cli campaigns deploy --template-html ./email.html --campaign-name "May offer" --list-id LIST_ID --subject "May offer" --from-email marketing@example.com --from-label "Marketing" --json
```
campaigns image-swap — Find a campaign message template and replace an image URL inside the HTML while preserving the rest of the draft.

Agents can make safe creative swaps without rebuilding a whole campaign.
```
klaviyo-pp-cli campaigns image-swap --campaign-id CAMPAIGN_ID --old-url https://cdn.example.com/old.jpg --new-url https://cdn.example.com/new.jpg --json
```

Behavior graph analytics

flow-decay — Identify flows whose open or click performance has decayed across recent time buckets using synced local data.

Agents can spot lifecycle automations that need refresh before revenue falls further.
```
klaviyo-pp-cli flow-decay --days 90 --threshold 0.15 --json
```
cohort — Group profiles by first event date and compute retention or repeat-action curves from synced profiles and events.

Agents can answer which acquisition cohorts keep buying without exporting CSVs.
```
klaviyo-pp-cli cohort --metric "Placed Order" --interval month --json --select cohort,profiles,retained
```
attribution — Join order events with campaign and flow attribution properties to summarize revenue by channel and source.

Agents can explain which automation or campaign generated revenue using local event evidence.
```
klaviyo-pp-cli attribution --metric "Placed Order" --group-by flow --since 2026-01-01 --json
```

Data hygiene

dedup — Find profiles that appear duplicated by email, phone, or cross-channel collisions in the local profile mirror.

Agents can flag customer records that split behavior and revenue history across identities.
```
klaviyo-pp-cli dedup --by email,phone --json
```
reconcile — Compare campaign UTM evidence with local Klaviyo order events and optional Shopify credentials when available.

Agents can check whether campaign performance agrees with order evidence before reporting numbers.
```
klaviyo-pp-cli reconcile --campaign-id CAMPAIGN_ID --since 2026-01-01 --json
```

Growth planning

plan brief-to-strategy — Turn a growth brief into a structured Klaviyo campaign, flow, segment, and experiment strategy.

Agents can convert strategy notes into a concrete Klaviyo execution plan.
```
klaviyo-pp-cli plan brief-to-strategy --brief ./brief.md --json
```
plan qa-gate — Run a launch-readiness checklist for links, offers, dates, timezone, fallback tokens, compliance, and deliverability flags.

Agents can block risky campaign launches with explicit findings instead of vague review notes.
```
klaviyo-pp-cli plan qa-gate --campaign-id CAMPAIGN_ID --json
```

Usage

Run klaviyo-pp-cli --help for the full command reference and flag list.

Commands

accounts

klaviyo-pp-cli accounts get - Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.

You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.Rate limits:Burst: 1/sSteady: 15/m

Scopes: accounts:read

klaviyo-pp-cli accounts get-id - Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.Rate limits:Burst: 1/sSteady: 15/m

Scopes: accounts:read

back-in-stock-subscriptions

Manage back in stock subscriptions

klaviyo-pp-cli back-in-stock-subscriptions create - Subscribe a profile to receive back in stock notifications. Check out our Back in Stock API guide for more details.

This endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use POST /client/back-in-stock-subscriptions.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:write profiles:write

campaign-clone

Manage campaign clone

klaviyo-pp-cli campaign-clone create - Clones an existing campaign, returning a new campaign based on the original with a new ID and name.Rate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:write

campaign-message-assign-template

Manage campaign message assign template

klaviyo-pp-cli campaign-message-assign-template assign-template-to-campaign-message - Creates a non-reusable version of the template and assigns it to the message.Rate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:write

campaign-messages

Manage campaign messages

klaviyo-pp-cli campaign-messages get - Returns a specific message based on a required id.Rate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:read

klaviyo-pp-cli campaign-messages update - Update a campaign messageRate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:write

campaign-recipient-estimation-jobs

Manage campaign recipient estimation jobs

klaviyo-pp-cli campaign-recipient-estimation-jobs get - Retrieve the status of a recipient estimation job triggered with the Create Campaign Recipient Estimation Job endpoint.Rate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:read

klaviyo-pp-cli campaign-recipient-estimation-jobs refresh-campaign-recipient-estimation - Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the Get Campaign Recipient Estimation Job endpoint to retrieve the status of this estimation job. Use the Get Campaign Recipient Estimation endpoint to retrieve the estimated recipient count for a given campaign.Rate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:write

campaign-recipient-estimations

Manage campaign recipient estimations

klaviyo-pp-cli campaign-recipient-estimations get - Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the Create Campaign Recipient Estimation Job endpoint.Rate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:read

campaign-send-jobs

Manage campaign send jobs

klaviyo-pp-cli campaign-send-jobs cancel-campaign-send - Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFTRate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:write

klaviyo-pp-cli campaign-send-jobs get - Get a campaign send jobRate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:read

klaviyo-pp-cli campaign-send-jobs send-campaign - Trigger a campaign to send asynchronouslyRate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:write

campaign-values-reports

Manage campaign values reports

klaviyo-pp-cli campaign-values-reports query-campaign-values - Returns the requested campaign analytics values dataRate limits:Burst: 1/sSteady: 2/mDaily: 225/d

Scopes: campaigns:read

campaigns

klaviyo-pp-cli campaigns create - Creates a campaign given a set of parameters, then returns it.Rate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:write

klaviyo-pp-cli campaigns delete - Delete a campaign with the given campaign ID.Rate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:write

klaviyo-pp-cli campaigns get - Returns some or all campaigns based on filters.

A channel filter is required to list campaigns. Please provide either: ?filter=equals(messages.channel,'email') to list email campaigns, or ?filter=equals(messages.channel,'sms') to list SMS campaigns. ?filter=equals(messages.channel,'mobile_push') to list mobile push campaigns.Rate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:read

klaviyo-pp-cli campaigns get-id - Returns a specific campaign based on a required id.Rate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:read

klaviyo-pp-cli campaigns update - Update a campaign with the given campaign ID.Rate limits:Burst: 10/sSteady: 150/m

Scopes: campaigns:write

catalog-categories

Manage catalog categories

klaviyo-pp-cli catalog-categories create-catalog-category - Create a new catalog category.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-categories delete-catalog-category - Delete a catalog category using the given category ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-categories get - Get all catalog categories in an account.

Catalog categories can be sorted by the following fields, in ascending and descending order: created

Currently, the only supported integration type is $custom, and the only supported catalog type is $default.

Returns a maximum of 100 categories per request.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-categories get-catalog-category - Get a catalog category with the given category ID.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-categories update-catalog-category - Update a catalog category with the given category ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

catalog-category-bulk-create-jobs

Manage catalog category bulk create jobs

klaviyo-pp-cli catalog-category-bulk-create-jobs bulk-create-catalog-categories - Create a catalog category bulk create job to create a batch of catalog categories.

Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-category-bulk-create-jobs get-bulk-create-categories-job - Get a catalog category bulk create job with the given job ID.

An include parameter can be provided to get the following related resource data: categories.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-category-bulk-create-jobs get-bulk-create-categories-jobs - Get all catalog category bulk create jobs.

Returns a maximum of 100 jobs per request.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

catalog-category-bulk-delete-jobs

Manage catalog category bulk delete jobs

klaviyo-pp-cli catalog-category-bulk-delete-jobs bulk-delete-catalog-categories - Create a catalog category bulk delete job to delete a batch of catalog categories.

Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-category-bulk-delete-jobs get-bulk-delete-categories-job - Get a catalog category bulk delete job with the given job ID.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-category-bulk-delete-jobs get-bulk-delete-categories-jobs - Get all catalog category bulk delete jobs.

Returns a maximum of 100 jobs per request.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

catalog-category-bulk-update-jobs

Manage catalog category bulk update jobs

klaviyo-pp-cli catalog-category-bulk-update-jobs bulk-update-catalog-categories - Create a catalog category bulk update job to update a batch of catalog categories.

Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-category-bulk-update-jobs get-bulk-update-categories-job - Get a catalog category bulk update job with the given job ID.

An include parameter can be provided to get the following related resource data: categories.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-category-bulk-update-jobs get-bulk-update-categories-jobs - Get all catalog category bulk update jobs.

Returns a maximum of 100 jobs per request.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

catalog-item-bulk-create-jobs

Manage catalog item bulk create jobs

klaviyo-pp-cli catalog-item-bulk-create-jobs bulk-create-catalog-items - Create a catalog item bulk create job to create a batch of catalog items.

Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-item-bulk-create-jobs get-bulk-create-catalog-items-job - Get a catalog item bulk create job with the given job ID.

An include parameter can be provided to get the following related resource data: items.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-item-bulk-create-jobs get-bulk-create-catalog-items-jobs - Get all catalog item bulk create jobs.

Returns a maximum of 100 jobs per request.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

catalog-item-bulk-delete-jobs

Manage catalog item bulk delete jobs

klaviyo-pp-cli catalog-item-bulk-delete-jobs bulk-delete-catalog-items - Create a catalog item bulk delete job to delete a batch of catalog items.

Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-item-bulk-delete-jobs get-bulk-delete-catalog-items-job - Get a catalog item bulk delete job with the given job ID.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-item-bulk-delete-jobs get-bulk-delete-catalog-items-jobs - Get all catalog item bulk delete jobs.

Returns a maximum of 100 jobs per request.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

catalog-item-bulk-update-jobs

Manage catalog item bulk update jobs

klaviyo-pp-cli catalog-item-bulk-update-jobs bulk-update-catalog-items - Create a catalog item bulk update job to update a batch of catalog items.

Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-item-bulk-update-jobs get-bulk-update-catalog-items-job - Get a catalog item bulk update job with the given job ID.

An include parameter can be provided to get the following related resource data: items.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-item-bulk-update-jobs get-bulk-update-catalog-items-jobs - Get all catalog item bulk update jobs.

Returns a maximum of 100 jobs per request.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

catalog-items

Manage catalog items

klaviyo-pp-cli catalog-items create - Create a new catalog item.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-items delete - Delete a catalog item with the given item ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-items get - Get all catalog items in an account.

Catalog items can be sorted by the following fields, in ascending and descending order: created

Currently, the only supported integration type is $custom, and the only supported catalog type is $default.

Returns a maximum of 100 items per request.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-items get-catalogitems - Get a specific catalog item with the given item ID.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-items update - Update a catalog item with the given item ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

catalog-variant-bulk-create-jobs

Manage catalog variant bulk create jobs

klaviyo-pp-cli catalog-variant-bulk-create-jobs bulk-create-catalog-variants - Create a catalog variant bulk create job to create a batch of catalog variants.

Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-variant-bulk-create-jobs get-bulk-create-variants-job - Get a catalog variant bulk create job with the given job ID.

An include parameter can be provided to get the following related resource data: variants.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-variant-bulk-create-jobs get-bulk-create-variants-jobs - Get all catalog variant bulk create jobs.

Returns a maximum of 100 jobs per request.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

catalog-variant-bulk-delete-jobs

Manage catalog variant bulk delete jobs

klaviyo-pp-cli catalog-variant-bulk-delete-jobs bulk-delete-catalog-variants - Create a catalog variant bulk delete job to delete a batch of catalog variants.

Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-variant-bulk-delete-jobs get-bulk-delete-variants-job - Get a catalog variant bulk delete job with the given job ID.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-variant-bulk-delete-jobs get-bulk-delete-variants-jobs - Get all catalog variant bulk delete jobs.

Returns a maximum of 100 jobs per request.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

catalog-variant-bulk-update-jobs

Manage catalog variant bulk update jobs

klaviyo-pp-cli catalog-variant-bulk-update-jobs bulk-update-catalog-variants - Create a catalog variant bulk update job to update a batch of catalog variants.

Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-variant-bulk-update-jobs get-bulk-update-variants-job - Get a catalog variate bulk update job with the given job ID.

An include parameter can be provided to get the following related resource data: variants.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-variant-bulk-update-jobs get-bulk-update-variants-jobs - Get all catalog variant bulk update jobs.

Returns a maximum of 100 jobs per request.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

catalog-variants

Manage catalog variants

klaviyo-pp-cli catalog-variants create - Create a new variant for a related catalog item.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-variants delete - Delete a catalog item variant with the given variant ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

klaviyo-pp-cli catalog-variants get - Get all variants in an account.

Variants can be sorted by the following fields, in ascending and descending order: created

Currently, the only supported integration type is $custom, and the only supported catalog type is $default.

Returns a maximum of 100 variants per request.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-variants get-catalogvariants - Get a catalog item variant with the given variant ID.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:read

klaviyo-pp-cli catalog-variants update - Update a catalog item variant with the given variant ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: catalogs:write

client

klaviyo-pp-cli client bulk-create-events - Create new events to track a profile's activity.

This endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a public API key (site ID). Never use a private API key with our client-side endpoints.

Do not use this endpoint from server-side applications. To create events from server-side applications, instead use POST /api/event-bulk-create-jobs.

Accepts a maximum of 1000 events per request.Rate limits:Burst: 10/sSteady: 150/m

Scopes: events:write

klaviyo-pp-cli client create-back-in-stock-subscription - Subscribe a profile to receive back in stock notifications. Check out our Back in Stock API guide for more details.

Do not use this endpoint from server-side applications. To create back in stock subscriptions from server-side applications, instead use POST /api/back-in-stock-subscriptions.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: catalogs:write profiles:write

klaviyo-pp-cli client create-event - Create a new event to track a profile's activity.

Do not use this endpoint from server-side applications. To create events from server-side applications, instead use POST /api/events.

Note that to update a profile's existing identifiers (e.g., email), you must use a server-side endpoint authenticated by a private API key. Attempts to do so via client-side endpoints will return a 202, however the identifier field(s) will not be updated.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: events:write

klaviyo-pp-cli client create-profile - Create or update properties about a profile without tracking an associated event.

Do not use this endpoint from server-side applications. To create or update profiles from server-side applications, instead use POST /api/profile-import.

Scopes: profiles:write

klaviyo-pp-cli client create-push-token - Create or update a push token.

This endpoint is specifically designed to be called from our mobile SDKs (iOS and Android) and requires a public API key (site ID). Never use a private API key with our client-side endpoints. You must have push notifications enabled to use this endpoint.

To migrate push tokens from another platform to Klaviyo, please use our server-side POST /api/push-tokens endpoint instead.Rate limits:Burst: 150/sSteady: 1400/m

klaviyo-pp-cli client create-review - Create a review with the given ID. This endpoint is for client-side environments only.Rate limits:Burst: 10/sSteady: 150/m
klaviyo-pp-cli client create-subscription - Creates a subscription and consent record for email and/or SMS channels based on the provided email and phone_number attributes, respectively. One of either email or phone_number must be provided.

Do not use this endpoint from server-side applications. To subscribe profiles from server-side applications, instead use POST /api/profile-subscription-bulk-create-jobs.

Profiles can be opted into multiple channels: email marketing, SMS marketing, and SMS transactional. You can specify the channel(s) to subscribe the profile to by providing a subscriptions object in the profile attributes.

If you include a subscriptions object, only channels in that object will be subscribed. You can use this to update email or phone on the profile without subscribing them, for example, by setting the profile property but omitting that channel in the subscriptions object. If a subscriptions object is not provided, subscriptions are defaulted to MARKETING.Rate limits:Burst: 350/sSteady: 750/m

Scopes: subscriptions:write

klaviyo-pp-cli client get-geofences - Get all geofences in an account.

Returns a paginated list of all geofences for the specified company. This is the GA API endpoint designed for mobile SDK consumption. No authentication required.

Returns a maximum of 100 results per page (default 20).

This API supports filtering via header instead of query param. Provide X-Klaviyo-API-Filters header to filter geofences. We don't use regular query param filters here because lat and long are sensitive information.

Supported filters:

lat (equals) - Latitude coordinate for distance-based sorting
lng (equals) - Longitude coordinate for distance-based sorting

When both lat and lng are provided, geofences are returned sorted by distance from the specified coordinates (closest first).

Example filter header: X-Klaviyo-API-Filters: and(equals(lat,40.7128),equals(lng,-74.0060))Rate limits:Burst: 3/sSteady: 60/m

klaviyo-pp-cli client get-review-values-reports - Get all reviews values reports in an account.Rate limits:Burst: 10/sSteady: 150/m
klaviyo-pp-cli client get-reviews - Get all reviews. This endpoint is for client-side environments only, for server-side use, refer to https://developers.klaviyo.com/en/reference/get_reviewsRate limits:Burst: 10/sSteady: 150/m
klaviyo-pp-cli client unregister-push-token - Unregister a push token.

conversation-messages

Manage conversation messages

klaviyo-pp-cli conversation-messages create - Send an outbound message to a conversation.

Requires OAuth authentication and account-level enablement. To request access, reach out in the developer community.Rate limits:Burst: 3/sSteady: 60/m

Scopes: conversations:write

coupon-code-bulk-create-jobs

Manage coupon code bulk create jobs

klaviyo-pp-cli coupon-code-bulk-create-jobs bulk-create-coupon-codes - Create a coupon-code-bulk-create-job to bulk create a list of coupon codes.

Max number of coupon codes per job we allow for is 1000. Max number of jobs queued at once we allow for is 100.Rate limits:Burst: 75/sSteady: 750/m

Scopes: coupon-codes:write

klaviyo-pp-cli coupon-code-bulk-create-jobs get-bulk-create-coupon-code-jobs - Get all coupon code bulk create jobs.

Returns a maximum of 100 jobs per request.Rate limits:Burst: 75/sSteady: 750/m

Scopes: coupon-codes:read

klaviyo-pp-cli coupon-code-bulk-create-jobs get-bulk-create-coupon-codes-job - Get a coupon code bulk create job with the given job ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: coupon-codes:read

coupon-codes

Manage coupon codes

klaviyo-pp-cli coupon-codes create - Synchronously creates a coupon code for the given coupon.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: coupon-codes:write

klaviyo-pp-cli coupon-codes delete - Deletes a coupon code specified by the given identifier synchronously. If a profile has been assigned to the coupon code, an exception will be raisedRate limits:Burst: 350/sSteady: 3500/m

Scopes: coupon-codes:write

klaviyo-pp-cli coupon-codes get - Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles.

A coupon/coupons or a profile/profiles must be provided as required filter params.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: coupon-codes:read

klaviyo-pp-cli coupon-codes get-couponcodes - Returns a Coupon Code specified by the given identifier.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: coupon-codes:read

klaviyo-pp-cli coupon-codes update - Updates a coupon code specified by the given identifier synchronously. We allow updating the 'status' and 'expires_at' of coupon codes.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: coupon-codes:write

coupons

klaviyo-pp-cli coupons create - Creates a new coupon.Rate limits:Burst: 3/sSteady: 60/m

Scopes: coupons:write

klaviyo-pp-cli coupons delete - Delete the coupon with the given coupon ID.Rate limits:Burst: 3/sSteady: 60/m

Scopes: coupons:write

klaviyo-pp-cli coupons get - Get all coupons in an account.

To learn more, see our Coupons API guide.Rate limits:Burst: 75/sSteady: 750/m

Scopes: coupons:read

klaviyo-pp-cli coupons get-id - Get a specific coupon with the given coupon ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: coupons:read

klaviyo-pp-cli coupons update - Rate limits:Burst: 3/sSteady: 60/m

Scopes: coupons:write

custom-metrics

Manage custom metrics

klaviyo-pp-cli custom-metrics create - Create a new custom metric.

Custom metric objects must include a name and definition.Rate limits:Burst: 1/sSteady: 15/mDaily: 15/d

Scopes: metrics:write

klaviyo-pp-cli custom-metrics delete - Delete a custom metric with the given custom metric ID.Rate limits:Burst: 3/sSteady: 60/m

Scopes: metrics:write

klaviyo-pp-cli custom-metrics get - Get all custom metrics in an account.Rate limits:Burst: 3/sSteady: 60/m

Scopes: metrics:read

klaviyo-pp-cli custom-metrics get-custommetrics - Get a custom metric with the given custom metric ID.Rate limits:Burst: 3/sSteady: 60/m

Scopes: metrics:read

klaviyo-pp-cli custom-metrics update - Update a custom metric with the given custom metric ID.Rate limits:Burst: 1/sSteady: 15/mDaily: 15/d

Scopes: metrics:write

data-privacy-deletion-jobs

Manage data privacy deletion jobs

klaviyo-pp-cli data-privacy-deletion-jobs request-profile-deletion - Request a deletion for the profiles corresponding to one of the following identifiers: email, phone_number, or id. If multiple identifiers are provided, we will return an error.

All profiles that match the provided identifier will be deleted.

The deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the Deleted Profiles page.

For more information on the deletion process, please refer to our Help Center docs on how to handle GDPR and CCPA deletion requests.Rate limits:Burst: 3/sSteady: 60/m

Scopes: data-privacy:write

data-source-record-bulk-create-jobs

Manage data source record bulk create jobs

klaviyo-pp-cli data-source-record-bulk-create-jobs bulk-create-data-source-records - Create a bulk data source record import job to create a batch of records.

Accepts up to 500 records per request. The maximum allowed payload size is 4MB. The maximum allowed payload size per-record is 512KB.

To learn more, see our Custom Objects API overview.Rate limits:Burst: 3/sSteady: 15/m

Scopes: custom-objects:write

data-source-record-create-jobs

Manage data source record create jobs

klaviyo-pp-cli data-source-record-create-jobs create-data-source-record - Create a data source record import job to create a single record.

The maximum allowed payload size per-record is 512KB.

To learn more, see our Custom Objects API overview.Rate limits:Burst: 75/sSteady: 750/m

Scopes: custom-objects:write

data-sources

Manage data sources

klaviyo-pp-cli data-sources create - Create a new data source in an accountRate limits:Burst: 3/sSteady: 60/m

Scopes: custom-objects:write

klaviyo-pp-cli data-sources delete - Delete a data source in an account.Rate limits:Burst: 3/sSteady: 60/m

Scopes: custom-objects:write

klaviyo-pp-cli data-sources get - Get all data sources in an account.Rate limits:Burst: 3/sSteady: 60/m

Scopes: custom-objects:read

klaviyo-pp-cli data-sources get-datasources - Retrieve a data source in an account.Rate limits:Burst: 3/sSteady: 60/m

Scopes: custom-objects:read

event-bulk-create-jobs

Manage event bulk create jobs

klaviyo-pp-cli event-bulk-create-jobs bulk-create-events - Create a batch of events for one or more profiles.

Note that this endpoint allows you to create new profiles or update existing profile properties.

At a minimum, profile and metric objects should include at least one profile identifier (e.g., id, email, or phone_number) and the metric name, respectively.

Accepts up to 1,000 events per request. The maximum allowed payload size is 5MB. A single string cannot exceed 100KB.Rate limits:Burst: 10/sSteady: 150/m

Scopes: events:write

events

klaviyo-pp-cli events create - Create a new event to track a profile's activity.

Note that this endpoint allows you to create a new profile or update an existing profile's properties.

At a minimum, profile and metric objects should include at least one profile identifier (e.g., id, email, or phone_number) and the metric name, respectively.

Successful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: events:write

klaviyo-pp-cli events get - Get all events in an account

Requests can be sorted by the following fields: datetime, timestamp

Custom metrics are not supported in the metric_id filter.

Returns a maximum of 200 events per page.Rate limits:Burst: 350/sSteady: 3500/m

Scopes: events:read

klaviyo-pp-cli events get-id - Get an event with the given event ID.Rate limits:Burst: 10/sSteady: 150/m

Scopes: events:read

flow-actions

Manage flow actions

klaviyo-pp-cli flow-actions get - Get a flow action from a flow with the given flow action ID.Rate limits:Burst: 3/sSteady: 60/m

Scopes: flows:read

klaviyo-pp-cli flow-actions update - Update a flow action.Rate limits:Burst: 3/sSteady: 60/m

Scopes: flows:write

flow-messages

Manage flow messages

klaviyo-pp-cli flow-messages get - Get a flow message from a flow with the given flow message ID.Rate limits:Burst: 3/sSteady: 60/m

Scopes: flows:read

flow-series-reports

Manage flow series reports

klaviyo-pp-cli flow-series-reports query-flow-series - Returns the requested flow analytics series dataRate limits:Burst: 1/sSteady: 2/mDaily: 225/d

Scopes: flows:read

flow-values-reports

Manage flow values reports

klaviyo-pp-cli flow-values-reports query-flow-values - Returns the requested flow analytics values dataRate limits:Burst: 1/sSteady: 2/mDaily: 225/d

Scopes: flows:read

flows

klaviyo-pp-cli flows create - Create a new flow using an encoded flow definition.

New objects within the flow definition, such as actions, will need to use a temporary_id field for identification. These will be replaced with traditional id fields after successful creation.

A successful request will return the new definition to you.Rate limits:Burst: 1/sSteady: 15/mDaily: 100/d

Scopes: flows:write

klaviyo-pp-cli flows delete - Delete a flow with the given flow ID.Rate limits:Burst: 3/sSteady: 60/m

Scopes: flows:write

klaviyo-pp-cli flows get - Get all flows in an account.

Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.Rate limits:Burst: 3/sSteady: 60/m

Scopes: flows:read

klaviyo-pp-cli flows get-id - Get a flow with the given flow ID.Rate limits:Burst: 3/sSteady: 60/m

Scopes: flows:read

klaviyo-pp-cli flows update - Update the status of a flow with the given flow ID, and all actions in that flow.Rate limits:Burst: 3/sSteady: 60/m

Scopes: flows:write

form-series-reports

Manage form series reports

klaviyo-pp-cli form-series-reports query-form-series - Returns the requested form analytics series data.Rate limits:Burst: 1/sSteady: 2/mDaily: 225/d

Scopes: forms:read

form-values-reports

Manage form values reports

klaviyo-pp-cli form-values-reports query-form-values - Returns the requested form analytics values data.Rate limits:Burst: 1/sSteady: 2/mDaily: 225/d

Scopes: forms:read

form-versions

Manage form versions

klaviyo-pp-cli form-versions get - Get the form version with the given ID.Rate limits:Burst: 3/sSteady: 60/m

Scopes: forms:read

forms

klaviyo-pp-cli forms create - Create a new form.Rate limits:Burst: 3/sSteady: 60/m

Scopes: forms:write

klaviyo-pp-cli forms delete - Delete a given form.Rate limits:Burst: 3/sSteady: 60/m

Scopes: forms:write

klaviyo-pp-cli forms get - Get all forms in an account.Rate limits:Burst: 3/sSteady: 60/m

Scopes: forms:read

klaviyo-pp-cli forms get-id - Get the form with the given ID.Rate limits:Burst: 3/sSteady: 60/m

Scopes: forms:read

image-upload

Manage image upload

klaviyo-pp-cli image-upload upload-image-from-file - Upload an image from a file.

If you want to import an image from an existing url or a data uri, use the Upload Image From URL endpoint instead.Rate limits:Burst: 3/sSteady: 100/mDaily: 100/d

Scopes: images:write

images

klaviyo-pp-cli images get - Get all images in an account.Rate limits:Burst: 10/sSteady: 150/m

Scopes: images:read

klaviyo-pp-cli images get-id - Get the image with the given image ID.Rate limits:Burst: 10/sSteady: 150/m

Scopes: images:read

klaviyo-pp-cli images update - Update the image with the given image ID.Rate limits:Burst: 10/sSteady: 150/m

Scopes: images:write

klaviyo-pp-cli images upload-from-url - Import an image from a url or data uri.

If you want to upload an image from a file, use the Upload Image From File endpoint instead.Rate limits:Burst: 3/sSteady: 100/mDaily: 100/d

Scopes: images:write

lists

klaviyo-pp-cli lists create - Create a new list.Rate limits:Burst: 10/sSteady: 150/mDaily: 150/d

Scopes: lists:write

klaviyo-pp-cli lists delete - Delete a list with the given list ID.Rate limits:Burst: 10/sSteady: 150/m

Scopes: lists:write

klaviyo-pp-cli lists get - Get all lists in an account.

Filter to request a subset of all lists. Lists can be filtered by id, name, created, and updated fields.

Returns a maximum of 10 results per page.Rate limits:Burst: 75/sSteady: 750/m

Scopes: lists:read

klaviyo-pp-cli lists get-id - Get a list with the given list ID.Rate limits:Burst: 75/sSteady: 750/mRate limits when using the additional-fields[list]=profile_count parameter in your API request:Burst: 1/sSteady: 15/mTo learn more about how the additional-fields parameter impacts rate limits, check out our Rate limits, status codes, and errors guide.

Scopes: lists:read

klaviyo-pp-cli lists update - Update the name of a list with the given list ID.Rate limits:Burst: 10/sSteady: 150/m

Scopes: lists:write

mapped-metrics

Manage mapped metrics

klaviyo-pp-cli mapped-metrics get - Get all mapped metrics in an account.Rate limits:Burst: 3/sSteady: 60/m

Scopes: metrics:read

klaviyo-pp-cli mapped-metrics get-mappedmetrics - Get the mapped metric with the given ID.Rate limits:Burst: 3/sSteady: 60/m

Scopes: metrics:read

klaviyo-pp-cli mapped-metrics update - Update the mapped metric with the given ID.Rate limits:Burst: 1/sSteady: 15/mDaily: 30/d

Scopes: metrics:write

metric-aggregates

Manage metric aggregates

klaviyo-pp-cli metric-aggregates query - Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events (not to be confused with custom metrics, which are not supported at this time). Queries must be passed in the JSON body of your POST request.

To request campaign and flow performance data that matches the data shown in Klaviyo's UI, we recommend the Reporting API.

Results can be filtered and grouped by time, event, or profile dimensions.

To learn more about how to use this endpoint, check out our new Using the Query Metric Aggregates Endpoint guide.

For a comprehensive list of request body parameters, native Klaviyo metrics, and their associated attributes for grouping and filtering, please refer to the metrics attributes guide.Rate limits:Burst: 3/sSteady: 60/m

Scopes: metrics:read

metric-properties

Manage metric properties

klaviyo-pp-cli metric-properties get-metric-property - Get a metric property with the given metric property ID.Rate limits:Burst: 1/sSteady: 15/m

Scopes: metrics:read

metrics

klaviyo-pp-cli metrics get - Get all metrics in an account.

Requests can be filtered by the following fields: integration name, integration category

Returns a maximum of 200 results per page.Rate limits:Burst: 10/sSteady: 150/m

Scopes: metrics:read

klaviyo-pp-cli metrics get-id - Get a metric with the given metric ID.Rate limits:Burst: 10/sSteady: 150/m

Scopes: metrics:read

profile-bulk-import-jobs

Manage profile bulk import jobs

klaviyo-pp-cli profile-bulk-import-jobs bulk-import-profiles - Create a bulk profile import job to create or update a batch of profiles.

Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. The maximum allowed payload size per-profile is 100KB.

To learn more, see our Bulk Profile Import API guide.Rate limits:Burst: 10/sSteady: 150/m

Scopes: lists:write profiles:write

klaviyo-pp-cli profile-bulk-import-jobs get-bulk-import-profiles-job - Get a bulk profile import job with the given job ID.Rate limits:Burst: 10/sSteady: 150/m

Scopes: lists:read profiles:read

klaviyo-pp-cli profile-bulk-import-jobs get-bulk-import-profiles-jobs - Get all bulk profile import jobs.

Returns a maximum of 100 jobs per request.Rate limits:Burst: 10/sSteady: 150/m

Scopes: lists:read profiles:read

profile-import

Manage profile import

klaviyo-pp-cli profile-import create-or-update-profile - Given a set of profile attributes and optionally an ID, create or update a profile.

Returns 201 if a new profile was created, 200 if an existing profile was updated.

Use the additional-fields parameter to include subscriptions and predictive analytics data in your response.

Note that setting a field to null will clear out the field, whereas not including a field in your request will leave it unchanged.

The maximum allowed payload size is 100KB.Rate limits:Burst: 75/sSteady: 750/m

Scopes: profiles:write

profile-merge

Manage profile merge

klaviyo-pp-cli profile-merge merge-profiles - Merge a given related profile into a profile with the given profile ID.

The profile provided under relationships (the "source" profile) will be merged into the profile provided by the ID in the base data object (the "destination" profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile.

To learn more about how profile data is preserved or overwritten during a merge, please visit our Help Center.Rate limits:Burst: 10/sSteady: 150/m

Scopes: profiles:write

profile-subscription-bulk-create-jobs

Manage profile subscription bulk create jobs

klaviyo-pp-cli profile-subscription-bulk-create-jobs bulk-subscribe-profiles - Subscribe one or more profiles to email marketing, SMS marketing, WhatsApp, or push. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about consent in this guide.

If a list is not provided, the opt-in process used will be determined by the account-level default opt-in setting.

To add someone to a list without changing their subscription status, use Add Profile to List.

This API will remove any UNSUBSCRIBE, SPAM_REPORT or USER_SUPPRESSED suppressions from the provided profiles. Learn more about suppressed profiles.

Maximum number of profiles can be submitted for subscription: 1000

This endpoint now supports a historical_import flag. If this flag is set true, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated "Added to list" flows. This is useful for importing historical data where you have already collected consent. If historical_import is set to true, the consented_at field is required and must be in the past.

Push tokens provided in push_tokens will be registered for each profile as long as push subscriptions are consented to.Rate limits:Burst: 75/sSteady: 750/m

Scopes: lists:write profiles:write subscriptions:write

profile-subscription-bulk-delete-jobs

Manage profile subscription bulk delete jobs

klaviyo-pp-cli profile-subscription-bulk-delete-jobs bulk-unsubscribe-profiles - > 🚧

Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes.

Unsubscribe one or more profiles from email marketing, SMS marketing, push marketing, or a combination. Learn more about consent in this guide.

Push tokens provided in subscriptions.push.tokens will be removed for the specified profiles.

To remove someone from a list without changing their subscription status, use Remove Profiles from List.

Maximum number of profiles per call: 100Rate limits:Burst: 75/sSteady: 750/m

Scopes: lists:write profiles:write subscriptions:write

profile-suppression-bulk-create-jobs

Manage profile suppression bulk create jobs

klaviyo-pp-cli profile-suppression-bulk-create-jobs bulk-suppress-profiles - Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list.

Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on email suppressions and collecting consent.

Email address per request limit: 100Rate limits:Burst: 75/sSteady: 750/m

Scopes: profiles:write subscriptions:write

klaviyo-pp-cli profile-suppression-bulk-create-jobs get-bulk-suppress-profiles-job - Get the bulk suppress profiles job with the given job ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: subscriptions:read

klaviyo-pp-cli profile-suppression-bulk-create-jobs get-bulk-suppress-profiles-jobs - Get the status of all bulk profile suppression jobs.Rate limits:Burst: 75/sSteady: 750/m

Scopes: subscriptions:read

profile-suppression-bulk-delete-jobs

Manage profile suppression bulk delete jobs

klaviyo-pp-cli profile-suppression-bulk-delete-jobs bulk-unsuppress-profiles - Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list.

This only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on email suppressions and collecting consent.

Email address per request limit: 100Rate limits:Burst: 75/sSteady: 750/m

Scopes: subscriptions:write

klaviyo-pp-cli profile-suppression-bulk-delete-jobs get-bulk-unsuppress-profiles-job - Get the bulk unsuppress profiles job with the given job ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: subscriptions:read

klaviyo-pp-cli profile-suppression-bulk-delete-jobs get-bulk-unsuppress-profiles-jobs - Get all bulk unsuppress profiles jobs.Rate limits:Burst: 75/sSteady: 750/m

Scopes: subscriptions:read

profiles

klaviyo-pp-cli profiles create - Create a new profile.

Use the additional-fields parameter to include subscriptions and predictive analytics data in your response.

The maximum allowed payload size is 100KB.Rate limits:Burst: 75/sSteady: 750/m

Scopes: profiles:write

klaviyo-pp-cli profiles get - Get all profiles in an account.

Profiles can be sorted by the following fields in ascending and descending order: id, created, updated, email, subscriptions.email.marketing.suppression.timestamp, subscriptions.email.marketing.list_suppressions.timestamp

Use the additional-fields parameter to include subscriptions and predictive analytics data in your response.Rate limits:Burst: 75/sSteady: 750/mRate limits when using the additional-fields[profile]=predictive_analytics parameter in your API request:Burst: 10/sSteady: 150/mTo learn more about how the additional-fields parameter impacts rate limits, check out our Rate limits, status codes, and errors guide.

Scopes: profiles:read

klaviyo-pp-cli profiles get-id - Get the profile with the given profile ID.

Use the additional-fields parameter to include subscriptions and predictive analytics data in your response.Rate limits:Burst: 75/sSteady: 750/mRate limits when using the include=list parameter in your API request:Burst: 1/sSteady: 15/mRate limits when using the include=segment parameter in your API request:Burst: 1/sSteady: 15/mTo learn more about how the include parameter impacts rate limits, check out our Rate limits, status codes, and errors guide.

Scopes: profiles:read

klaviyo-pp-cli profiles update - Update the profile with the given profile ID.

Use the additional-fields parameter to include subscriptions and predictive analytics data in your response.

Note that setting a field to null will clear out the field, whereas not including a field in your request will leave it unchanged.

The maximum allowed payload size is 100KB.Rate limits:Burst: 75/sSteady: 750/m

Scopes: profiles:write

push-tokens

Manage push tokens

klaviyo-pp-cli push-tokens create - Create or update a push token.

This endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs (iOS and Android) to create push tokens from users' devices.

The maximum allowed payload size is 100KB.Rate limits:Burst: 75/sSteady: 750/m

Scopes: profiles:write push-tokens:write

klaviyo-pp-cli push-tokens delete - Delete a specific push token based on its ID.Rate limits:Burst: 3/sSteady: 60/m

Scopes: push-tokens:write

klaviyo-pp-cli push-tokens get - Return push tokens associated with company.Rate limits:Burst: 10/sSteady: 150/m

Scopes: profiles:read push-tokens:read

klaviyo-pp-cli push-tokens get-pushtokens - Return a specific push token based on its ID.Rate limits:Burst: 10/sSteady: 150/m

Scopes: profiles:read push-tokens:read

reviews

klaviyo-pp-cli reviews get - Get all reviews.Rate limits:Burst: 10/sSteady: 150/m

Scopes: reviews:read

klaviyo-pp-cli reviews get-id - Get the review with the given ID.Rate limits:Burst: 10/sSteady: 150/m

Scopes: reviews:read

klaviyo-pp-cli reviews update - Update a review.Rate limits:Burst: 10/sSteady: 150/m

Scopes: reviews:write

segment-series-reports

Manage segment series reports

klaviyo-pp-cli segment-series-reports query-segment-series - Returns the requested segment analytics series data.Rate limits:Burst: 1/sSteady: 2/mDaily: 225/d

Scopes: segments:read

segment-values-reports

Manage segment values reports

klaviyo-pp-cli segment-values-reports query-segment-values - Returns the requested segment analytics values data.Rate limits:Burst: 1/sSteady: 2/mDaily: 225/d

Scopes: segments:read

segments

klaviyo-pp-cli segments create - Create a segment.Rate limits:Burst: 1/sSteady: 15/mDaily: 100/d

Scopes: segments:write

klaviyo-pp-cli segments delete - Delete a segment with the given segment ID.Rate limits:Burst: 3/sSteady: 60/m

Scopes: segments:write

klaviyo-pp-cli segments get - Get all segments in an account.

Filter to request a subset of all segments. Segments can be filtered by name, created, and updated fields.

Returns a maximum of 10 results per page.Rate limits:Burst: 75/sSteady: 750/m

Scopes: segments:read

klaviyo-pp-cli segments get-id - Get a segment with the given segment ID.Rate limits:Burst: 75/sSteady: 750/mRate limits when using the additional-fields[segment]=profile_count parameter in your API request:Burst: 1/sSteady: 15/mTo learn more about how the additional-fields parameter impacts rate limits, check out our Rate limits, status codes, and errors guide.

Scopes: segments:read

klaviyo-pp-cli segments update - Update a segment with the given segment ID.Rate limits:Burst: 1/sSteady: 15/mDaily: 100/d

Scopes: segments:write

tag-groups

Manage tag groups

klaviyo-pp-cli tag-groups create - Create a tag group. An account cannot have more than 50 unique tag groups.

If exclusive is not specified true or false, the tag group defaults to non-exclusive.

If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.Rate limits:Burst: 3/sSteady: 60/m

Scopes: tags:read tags:write

klaviyo-pp-cli tag-groups delete - Delete the tag group with the given tag group ID.

Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.Rate limits:Burst: 3/sSteady: 60/m

Scopes: tags:read tags:write

klaviyo-pp-cli tag-groups get - List all tag groups in an account. Every account has one default tag group.

Tag groups can be filtered by name, exclusive, and default, and sorted by name or id in ascending or descending order.

Returns a maximum of 25 tag groups per request, which can be paginated with cursor-based pagination.Rate limits:Burst: 3/sSteady: 60/m

Scopes: tags:read

klaviyo-pp-cli tag-groups get-taggroups - Retrieve the tag group with the given tag group ID.Rate limits:Burst: 3/sSteady: 60/m

Scopes: tags:read

klaviyo-pp-cli tag-groups update - Update the tag group with the given tag group ID.

Only a tag group's name can be changed. A tag group's exclusive or default value cannot be changed.Rate limits:Burst: 3/sSteady: 60/m

Scopes: tags:read tags:write

template-clone

Manage template clone

klaviyo-pp-cli template-clone clone-template - Create a clone of a template with the given template ID.

If there are 1,000 or more templates in an account, cloning will fail as there is a limit of 1,000 templates that can be created via the API.Rate limits:Burst: 75/sSteady: 750/m

Scopes: templates:write

template-render

Manage template render

klaviyo-pp-cli template-render render-template - Render a template with the given template ID and context attribute. Returns the AMP, HTML, and plain text versions of the email template.

Request body parameters (nested under attributes):

return_fields: Request specific fields using sparse fieldsets.
context: This is the context your email template will be rendered with. You must pass in a context object as a JSON object.

Email templates are rendered with contexts in a similar manner to Django templates. Nested template variables can be referenced via dot notation. Template variables without corresponding context values are treated as FALSE and output nothing.

Ex. { "name" : "George Washington", "state" : "VA" }Rate limits:Burst: 3/sSteady: 60/m

Scopes: templates:read

template-universal-content

Manage template universal content

klaviyo-pp-cli template-universal-content create-universal-content - Create universal content. Currently supported block types are: button, drop_shadow, horizontal_rule, html, image, spacer, and text.Rate limits:Burst: 75/sSteady: 750/m

Scopes: templates:write

klaviyo-pp-cli template-universal-content delete-universal-content - Delete the universal content with the given ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: templates:write

klaviyo-pp-cli template-universal-content get-all-universal-content - Get all universal content in an account.Rate limits:Burst: 75/sSteady: 750/m

Scopes: templates:read

klaviyo-pp-cli template-universal-content get-universal-content - Get the universal content with the given ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: templates:read

klaviyo-pp-cli template-universal-content update-universal-content - Update universal content. The definition field can only be updated on the following block types at this time: button, drop_shadow, horizontal_rule, html, image, spacer, and text.Rate limits:Burst: 75/sSteady: 750/m

Scopes: templates:write

templates

klaviyo-pp-cli templates create - Create a new HTML or drag-and-drop template.

If there are 1,000 or more templates in an account, creation will fail as there is a limit of 1,000 templates that can be created via the API.

Request specific fields using sparse fieldsets.Rate limits:Burst: 75/sSteady: 750/m

Scopes: templates:write

klaviyo-pp-cli templates delete - Delete a template with the given template ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: templates:write

klaviyo-pp-cli templates get - Get all templates in an account.

Use additional-fields[template]=definition to include the full template definition for SYSTEM_DRAGGABLE templates.Rate limits:Burst: 75/sSteady: 750/m

Scopes: templates:read

klaviyo-pp-cli templates get-id - Get a template with the given template ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: templates:read

klaviyo-pp-cli templates update - Update a template with the given template ID.Rate limits:Burst: 75/sSteady: 750/m

Scopes: templates:write

tracking-settings

tracking settings

klaviyo-pp-cli tracking-settings get - Get all UTM tracking settings in an account. Returns an array with a single tracking setting.

More information about UTM tracking settings can be found here.Rate limits:Burst: 10/sSteady: 150/m

Scopes: tracking-settings:read

klaviyo-pp-cli tracking-settings get-trackingsettings - Get the UTM tracking setting with the given account ID.

More information about UTM tracking settings can be found here.Rate limits:Burst: 10/sSteady: 150/m

Scopes: tracking-settings:read

klaviyo-pp-cli tracking-settings update - Update the UTM tracking setting with the given account ID.

More information about UTM tracking settings can be found here.Rate limits:Burst: 10/sSteady: 150/m

Scopes: tracking-settings:write

web-feeds

web feeds

klaviyo-pp-cli web-feeds create - Create a web feed.Rate limits:Burst: 1/sSteady: 15/m

Scopes: web-feeds:write

klaviyo-pp-cli web-feeds delete - Delete the web feed with the given ID.Rate limits:Burst: 1/sSteady: 15/m

Scopes: web-feeds:write

klaviyo-pp-cli web-feeds get - Get all web feeds for an account.Rate limits:Burst: 1/sSteady: 15/m

Scopes: web-feeds:read

klaviyo-pp-cli web-feeds get-webfeeds - Get the web feed with the given ID.Rate limits:Burst: 1/sSteady: 15/m

Scopes: web-feeds:read

klaviyo-pp-cli web-feeds update - Update the web feed with the given ID.Rate limits:Burst: 1/sSteady: 15/m

Scopes: web-feeds:write

webhook-topics

Manage webhook topics

klaviyo-pp-cli webhook-topics get - Get all webhook topics in a Klaviyo account.Rate limits:Burst: 1/sSteady: 15/m

Scopes: webhooks:read

klaviyo-pp-cli webhook-topics get-webhooktopics - Get the webhook topic with the given ID.Rate limits:Burst: 1/sSteady: 15/m

Scopes: webhooks:read

webhooks

klaviyo-pp-cli webhooks create - Create a new WebhookRate limits:Burst: 1/sSteady: 15/m

Scopes: webhooks:write

klaviyo-pp-cli webhooks delete - Delete a webhook with the given ID.Rate limits:Burst: 1/sSteady: 15/m

Scopes: webhooks:write

klaviyo-pp-cli webhooks get - Get all webhooks in an account.Rate limits:Burst: 1/sSteady: 15/m

Scopes: webhooks:read

klaviyo-pp-cli webhooks get-id - Get the webhook with the given ID.Rate limits:Burst: 1/sSteady: 15/m

Scopes: webhooks:read

klaviyo-pp-cli webhooks update - Update the webhook with the given ID.Rate limits:Burst: 1/sSteady: 15/m

Scopes: webhooks:write

Output Formats

# Human-readable table (default in terminal, JSON when piped)
klaviyo-pp-cli accounts get

# JSON for scripting and agents
klaviyo-pp-cli accounts get --json

# Filter to specific fields
klaviyo-pp-cli accounts get --json --select id,name,status

# Dry run — show the request without sending
klaviyo-pp-cli accounts get --dry-run

# Agent mode — JSON + compact + no prompts in one flag
klaviyo-pp-cli accounts get --agent

Agent Usage

This CLI is designed for AI agent consumption:

Non-interactive - never prompts, every input is a flag
Pipeable - --json output to stdout, errors to stderr
Filterable - --select id,name returns only fields you need
Previewable - --dry-run shows the request without sending
Retryable - creates return "already exists" on retry, deletes return "already deleted"
Confirmable - --yes for explicit confirmation of destructive actions
Piped input - write commands can accept structured input when their help lists --stdin
Offline-friendly - sync/search commands can use the local SQLite store when available
Agent-safe by default - no colors or formatting unless --human-friendly is set

Exit codes: 0 success, 2 usage error, 3 not found, 4 auth error, 5 API error, 7 rate limited, 10 config error.

Health Check

klaviyo-pp-cli doctor

Verifies configuration, credentials, and connectivity to the API.

Configuration

Config file: ~/.config/klaviyo-pp-cli/config.toml

Environment variables:

KLAVIYO_API_KEY

Troubleshooting

Authentication errors (exit code 4)

Run klaviyo-pp-cli doctor to check credentials
Verify the environment variable is set: echo $KLAVIYO_API_KEY Not found errors (exit code 3)
Check the resource ID is correct
Run the list command to see available items

API-specific

401 or 403 from every endpoint — Confirm KLAVIYO_API_KEY contains a private API key value, not the literal placeholder token.
Empty local search results — Run sync for the relevant resources first, such as sync metrics, sync profiles, or sync events.

Sources & Inspiration

This CLI was built by studying these projects and resources:

Klaviyo hosted MCP — mcp
klaviyo-api-python — Python

Generated by CLI Printing Press

For agents: pass /documentation/klaviyo/agents.md to install this CLI from a prompt.