> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # Klaviyo > Klaviyo is a data-driven email and SMS marketing platform that allows e-commerce brands to deliver targeted messages, track conversions, and scale customer relationships Klaviyo is a data-driven email and SMS marketing platform that allows e-commerce brands to deliver targeted messages, track conversions, and scale customer relationships `klaviyo` · **225 tools** · no triggers ## Connect it ```bash theme={"theme":"github-dark"} run auth klaviyo run auth klaviyo --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run klaviyo # common commands run klaviyo --all # every command ``` ```ts theme={"theme":"github-dark"} import { klaviyo } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-profile-to-list` | Add profiles to a Klaviyo list by profile IDs or email addresses. | | `cancel-campaign-send` | Cancel or revert a campaign send job. Use 'cancel' to permanently stop a campaign (status becomes CANCELED), or 'revert' to return it to DRAFT for editing. | | `create-campaign-recipient-estimation-job` | Start an asynchronous task to estimate the number of recipients for a campaign. | | `create-event` | Create or update a profile event with minimum identifiers and metric name. | | `create-list` | Create a new list. *Rate limits*: Burst: `10/s` Steady: `150/m` Daily: `100/d` **Scopes:** `lists:write` | | `create-or-update-profile` | Create or update a profile in Klaviyo with the given attributes. | | `create-profile` | Create a new profile. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `profiles:write` | | `get-bulk-delete-catalog-items-job` | Get a catalog item bulk delete job with the given job ID. Use this to check the status and progress of a bulk delete operation for catalog items. | | `get-bulk-update-categories-job` | Retrieve a catalog category bulk update job by its ID from Klaviyo. | | `get-campaign` | Retrieve a specific campaign by its ID from Klaviyo. This action fetches detailed information about a single campaign including its name, status... | | `get-campaigns` | Retrieve campaigns from your Klaviyo account. This action allows you to fetch campaigns with optional filtering and sorting. | | `get-events` | Get all events in an account Requests can be sorted by the following fields: `datetime`, `timestamp` Returns a maximum of 200 events per page. \*Rate... | | `get-lists` | Retrieve marketing lists from your Klaviyo account. This action allows you to fetch lists with optional filtering and sorting. | | `get-profiles` | Retrieve profiles from your Klaviyo account. This action allows you to fetch profiles with optional filtering and sorting. | | `update-campaign` | Update a campaign with the specified attributes. This action allows you to modify campaign settings including name, audiences, and send strategy. | | Tool | What it does | | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-profile-to-list` | Add profiles to a Klaviyo list by profile IDs or email addresses. | | `assign-campaign-message-template` | Creates a non-reusable version of the template and assigns it to the message. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` | | `bulk-create-client-events` | Use the client-side endpoint with a public API key to track profile activity. | | `bulk-create-events` | Bulk create events for multiple profiles in a single request. | | `cancel-campaign-send` | Cancel or revert a campaign send job. Use 'cancel' to permanently stop a campaign (status becomes CANCELED), or 'revert' to return it to DRAFT for editing. | | `create-back-in-stock-subscription` | Use the server-side endpoint to subscribe to restock alerts, following the Back in Stock API guide. | | `create-campaign` | Creates a campaign given a set of parameters, then returns it. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` | | `create-campaign-clone` | Clones an existing campaign, returning a new campaign based on the original with a new ID and name. *Rate limits*: Burst: `10/s` Steady: `150/m`... | | `create-campaign-recipient-estimation-job` | Start an asynchronous task to estimate the number of recipients for a campaign. | | `create-campaign-send-job` | Trigger a campaign to send asynchronously *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` | | `create-catalog-category` | Create a new catalog category. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `create-catalog-category-relationships-items` | Create a new item relationship for the given category ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `create-catalog-item` | Create a new catalog item. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `create-catalog-item-relationships-categories` | Create a new catalog category relationship for the given item ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `create-catalog-variant` | Create a new variant for a related catalog item. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `create-client-back-in-stock-subscription` | Use the endpoint for client-side back in stock notifications with a public API key. | | `create-client-event2` | Create a client-side event in Klaviyo to track user interactions. | | `create-client-subscription` | Endpoint manages email/SMS opt-ins using consent and requires public API key for client use. | | `create-coupon` | Creates a new coupon. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `coupons:write` | | `create-coupon-code` | Synchronously creates a coupon code for the given coupon. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `coupon-codes:write` | | `create-event` | Create or update a profile event with minimum identifiers and metric name. | | `create-list` | Create a new list. *Rate limits*: Burst: `10/s` Steady: `150/m` Daily: `100/d` **Scopes:** `lists:write` | | `create-or-update-client-profile` | Update user profiles without tracking using a public client-side API; use a private server-side API for identifier changes. | | `create-or-update-client-push-token` | This endpoint for mobile SDKs (iOS & Android) creates/updates push tokens using a public API key. | | `create-or-update-profile` | Create or update a profile in Klaviyo with the given attributes. | | `create-or-update-push-token` | Create or update a push token for mobile push notifications. | | `create-profile` | Create a new profile. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `profiles:write` | | `create-segment` | Create a segment. *Rate limits*: Burst: `1/s` Steady: `15/m` Daily: `100/d` **Scopes:** `segments:write` | | `create-tag` | Summary: Instructions on creating a tag within an account's designated tag group with a maximum of 500 tags, with optional tag group specification. | | `create-tag-group` | Create tag groups up to 50 per account, defaulting to non-exclusive unless specified. | | `create-tag-relationships` | Associate a tag with other resources (flows, lists, segments, or campaigns) in Klaviyo. | | `create-template` | Summary: Custom HTML templates can be created unless an account reaches 1,000 template limit. | | `create-template-clone` | Clone a template by its ID, but cloning fails if account has 1,000+ templates. | | `create-template-render` | Render an email template with specific context and sparse fieldsets, then get HTML/plain text. | | `create-webhook` | Create a new Webhook to receive real-time notifications when specific events occur in Klaviyo (e.g., email clicks, SMS sent). | | `delete-campaign` | Delete a campaign with the given campaign ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` | | `delete-catalog-category` | Delete a catalog category using the given category ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `delete-catalog-category-relationships-items` | Delete item relationships for the given category ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `delete-catalog-item` | Delete a catalog item with the given item ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `delete-catalog-item-relationships-categories` | Delete catalog category relationships for the given item ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `delete-catalog-variant` | Delete a catalog item variant with the given variant ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `delete-coupon` | Delete the coupon with the given coupon ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `coupons:write` | | `delete-coupon-code` | Deletes a coupon code specified by the given identifier synchronously. | | `delete-flow` | Delete a flow with the given flow ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:write` | | `delete-list` | Delete a list with the given list ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:write` | | `delete-segment` | Delete a segment with the given segment ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `segments:write` | | `delete-tag` | Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed. *Rate limits*: Burst: `3/s` Steady... | | `delete-tag-group` | Delete a specified tag group and its contents; associated resource links will be removed. | | `delete-tag-relationships` | Remove a tag's association with other resources like flows, campaigns, lists, or segments. | | `delete-template` | Permanently delete a template from your Klaviyo account using its unique template ID. | | `delete-webhook` | Permanently delete a webhook subscription from your Klaviyo account. | | `get-account` | 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*... | | `get-accounts` | Use a private API key to fetch an associated account's details like contact info, timezone, and currency, as well as validate the key. | | `get-bulk-create-coupon-codes-job` | Tool to get a coupon code bulk create job with the given job ID. | | `get-bulk-delete-catalog-items-job` | Get a catalog item bulk delete job with the given job ID. Use this to check the status and progress of a bulk delete operation for catalog items. | | `get-bulk-profile-import-job` | Get a bulk profile import job with the given job ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:read` `profiles:read` | | `get-bulk-profile-import-job-errors` | Get import errors for the bulk profile import job with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `profiles:read` | | `get-bulk-profile-import-job-lists` | Get list for the bulk profile import job with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:read` | | `get-bulk-profile-import-job-profiles` | Get profiles for the bulk profile import job with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `profiles:read` | | `get-bulk-profile-import-job-relationships-lists` | Get list relationship for the bulk profile import job with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:read` | | `get-bulk-profile-import-job-relationships-profiles` | Get profile relationships for the bulk profile import job with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `profiles:read` | | `get-bulk-profile-import-jobs` | Get all bulk profile import jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:read` `profiles:read` | | `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`. | | `get-bulk-update-categories-job` | Retrieve a catalog category bulk update job by its ID from Klaviyo. | | `get-bulk-update-variants-job` | Tool to retrieve a catalog variant bulk update job by its ID. | | `get-campaign` | Retrieve a specific campaign by its ID from Klaviyo. This action fetches detailed information about a single campaign including its name, status... | | `get-campaign-campaign-messages` | Return all messages that belong to the given campaign. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` | | `get-campaign-message` | Returns a specific message based on a required id. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` | | `get-campaign-message-campaign` | Return the related campaign *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` | | `get-campaign-message-relationships-campaign` | Returns the ID of the related campaign *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` | | `get-campaign-message-relationships-template` | Returns the ID of the related template *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` `templates:read` | | `get-campaign-message-template` | Return the related template *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` `templates:read` | | `get-campaign-recipient-estimation` | Get estimated recipients for a given campaign ID using `Create Campaign Recipient Estimation Job`. | | `get-campaign-recipient-estimation-job` | Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint. *Rate limits*: Burst... | | `get-campaign-relationships-campaign-messages` | Returns the IDs of all messages associated with the given campaign. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` | | `get-campaign-relationships-tags` | Returns the IDs of all tags associated with the given campaign. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `campaigns:read` `tags:read` | | `get-campaigns` | Retrieve campaigns from your Klaviyo account. This action allows you to fetch campaigns with optional filtering and sorting. | | `get-campaign-send-job` | Get a campaign send job *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` | | `get-campaign-tags` | Return all tags that belong to the given campaign. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `campaigns:read` `tags:read` | | `get-catalog-categories` | Retrieve up to 100 account catalog categories, sortable by creation date. | | `get-catalog-category` | Get a catalog category with the given category ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-catalog-category-items` | Retrieve up to 100 sorted items per request from a category using the category ID. | | `get-catalog-category-relationships-items` | Get all items in the given category ID. Returns a maximum of 100 items per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-catalog-item` | Get a specific catalog item with the given item ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-catalog-item-categories` | Retrieve the catalog categories for an item by ID, sorted by 'created' date, with a 100-category maximum per request. | | `get-catalog-item-relationships-categories` | Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request. *Rate limits*: Burst: `350/s` Steady... | | `get-catalog-items` | Retrieve up to 100 sorted catalog items per account, with `$custom` integration and `$default` type. | | `get-catalog-item-variants` | Retrieve up to 100 variants per request for a specific item ID, sortable by creation date. | | `get-catalog-variant` | Get a catalog item variant with the given variant ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-catalog-variants` | Retrieve up to 100 account variants per request, sortable by creation date. | | `get-coupon` | Get a specific coupon with the given coupon ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `coupons:read` | | `get-coupon-code` | Returns a Coupon Code specified by the given identifier. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `coupon-codes:read` | | `get-coupon-code-bulk-create-job` | Get a coupon code bulk create job with the given job ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `coupon-codes:read` | | `get-coupon-code-bulk-create-jobs` | Get all coupon code bulk create jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `coupon-codes:read` | | `get-coupon-code-relationships-coupon` | Gets a list of coupon code relationships associated with the given coupon id *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `coupon-codes:read` | | `get-coupon-codes` | Obtains coupon codes using necessary coupon or profile filters. | | `get-coupon-codes-for-coupon` | Gets a list of coupon codes associated with the given coupon id *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `coupon-codes:read` | | `get-coupon-for-coupon-code` | Get the coupon associated with a given coupon code ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `coupons:read` | | `get-coupon-id-for-coupon-code` | Tool to get the coupon relationship associated with a given coupon code ID. | | `get-coupon-relationships-coupon-codes` | Retrieves the coupon code relationships (resource identifiers) for a given coupon. | | `get-coupons` | Get all coupons in an account. To learn more, see our [Coupons API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_coupons_api). \*Rate... | | `get-create-categories-job` | Get a catalog category bulk create job with the given job ID. | | `get-create-categories-jobs` | Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-create-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`... | | `get-create-items-jobs` | Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-create-variants-job` | Get a catalog variant bulk create job with the given job ID. | | `get-create-variants-jobs` | Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-delete-categories-job` | Get a catalog category bulk delete job with the given job ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-delete-categories-jobs` | Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-delete-items-jobs` | Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-delete-variants-job` | Get a catalog variant bulk delete job with the given job ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-delete-variants-jobs` | Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-event` | Get an event with the given event ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `events:read` | | `get-event-metric` | Get the metric for an event with the given event ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `events:read` `metrics:read` | | `get-event-profile` | Get the profile associated with an event with the given event ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `events:read` `profiles:read` | | `get-event-relationships` | Get metrics or profile relationships for a specific event. Use when you need to retrieve the metric or profile associated with an event. | | `get-events` | Get all events in an account Requests can be sorted by the following fields: `datetime`, `timestamp` Returns a maximum of 200 events per page. \*Rate... | | `get-flow` | Get a flow with the given flow ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` | | `get-flow-action` | Get a flow action from a flow with the given flow action ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` | | `get-flow-action-for-message` | Get the flow action for a flow message with the given message ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` | | `get-flow-action-messages` | Retrieve up to 50 flow messages per request by action ID, sortable by various fields, with ascending/descending options, and paginated using... | | `get-flow-action-relationships-flow` | Get the parent flow associated with a given flow action ID. This endpoint returns the flow relationship data for a specific flow action, allowing you... | | `get-flow-action-relationships-messages` | Retrieves up to 50 flow message relationships per request for a specified flow action ID, with cursor pagination. | | `get-flow-flow-actions` | Get all flow actions associated with the given flow ID. Returns a maximum of 50 flow actions per request, which can be paginated with cursor-based... | | `get-flow-for-flow-action` | Get the flow associated with the given action ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` | | `get-flow-message` | Get the flow message of a flow with the given message ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` | | `get-flow-message-relationships-action` | Get the flow action relationship for a specific flow message. | | `get-flow-message-relationships-template` | Returns the ID of the related template *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `templates:read` | | `get-flow-message-template` | Return the related template *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `templates:read` | | `get-flow-relationships-flow-actions` | Retrieve all flow action relationships for a specific flow ID, sortable by `id`, `status`, `created`, `updated`. | | `get-flow-relationships-tags` | Return the tag IDs of all tags associated with the given flow. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` `tags:read` | | `get-flows` | 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... | | `get-flow-tags` | Return all tags associated with the given flow ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` `tags:read` | | `get-form` | Get the form with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:read` | | `get-form-for-form-version` | Get the form associated with the given form version. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:read` | | `get-form-id-for-form-version` | Get the ID of the form associated with the given form version. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:read` | | `get-forms` | Get all forms in an account. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:read` | | `get-form-version` | Retrieve detailed information about a specific form version by its ID. | | `get-image` | Get the image with the given image ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `images:read` | | `get-images` | Get all images in an account. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `images:read` | | `get-list` | API allows 75 req/sec and 700 req/min, but with 'profile\_count' param, it's 1 req/sec and 15 req/min. 'lists:read' scope needed. | | `get-list-profiles` | Retrieve profiles in a list by ID, filterable by email/phone/push token/join date, sortable by join date. | | `get-list-relationships` | Get profile membership relationships for a Klaviyo list. Returns references (IDs) to profiles that are members of the specified list. | | `get-list-relationships-tags` | Returns the tag IDs of all tags associated with the given list. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `lists:read` `tags:read` | | `get-lists` | Retrieve marketing lists from your Klaviyo account. This action allows you to fetch lists with optional filtering and sorting. | | `get-list-tags` | Return all tags associated with the given list ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `lists:read` `tags:read` | | `get-metric` | Get a metric with the given metric ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `metrics:read` | | `get-metrics` | Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200... | | `get-profile` | Get the profile with the given profile ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `profiles:read` | | `get-profile-lists` | Get list memberships for a profile with the given profile ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `lists:read` `profiles:read` | | `get-profile-relationships` | Tool to get list membership or segment membership relationships for a profile with the given profile ID. | | `get-profiles` | Retrieve profiles from your Klaviyo account. This action allows you to fetch profiles with optional filtering and sorting. | | `get-profile-segments` | Get segment memberships for a profile with the given profile ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `profiles:read` `segments:read` | | `get-segment` | Fetch a segment by ID with default rates of 75/s and 700/m, or with `additional-fields` at 1/s and 15/m. | | `get-segment-profiles` | Retrieve profiles in a segment by ID, filtering by email, phone, token, or join date, and sorting by join date. | | `get-segment-relationships` | Get all profile membership or tag relationships for a segment. | | `get-segments` | Fetch segments from an account with filters like `name`, `created`, and `updated`. | | `get-segment-tags` | Return all tags associated with the given segment ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `segments:read` `tags:read` | | `get-tag` | Retrieve the tag with the given tag ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` | | `get-tag-group` | Retrieve the tag group with the given tag group ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` | | `get-tag-group-relationships-tags` | Returns the tag IDs of all tags inside the given tag group. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` | | `get-tag-groups` | Retrieve up to 25 tag groups per account, sortable/filterable by specific attributes. | | `get-tag-group-tags` | Return the tags for a given tag group ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` | | `get-tag-relationships` | Tool to retrieve relationship IDs for a tag. Returns the IDs of related resources (campaigns, flows, lists, segments, or tag-group) associated with a specific tag. | | `get-tags` | Retrieve up to 50 account tags at once, filterable/sortable by name or id, with cursor pagination. | | `get-tag-tag-group` | Returns the tag group resource for a given tag ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` | | `get-template` | Get a template with the given template ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `templates:read` | | `get-templates` | Retrieve account templates with sorting options (`id`, `name`, `created`, `updated`). | | `get-update-categories-jobs` | Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-update-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`... | | `get-update-items-jobs` | Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-update-variants-jobs` | Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` | | `get-variant-ids-for-catalog-item` | Tool to get all variant IDs related to a given catalog item ID. | | `get-version-ids-for-form` | Get the IDs of the form versions for the given form. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:read` | | `get-versions-for-form` | Get the form versions for the given form. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:read` | | `get-webhook` | Get the webhook with the given ID. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `webhooks:read` | | `get-webhooks` | Get all webhooks in an account. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `webhooks:read` | | `get-webhook-topic` | Retrieve details of a specific webhook topic by its ID. Webhook topics define the events that can trigger webhooks (e.g., email\_delivered, sent\_sms). | | `get-webhook-topics` | Get all webhook topics in a Klaviyo account. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `webhooks:read` | | `merge-profiles` | Merge one or more source profiles into a destination profile. | | `query-campaign-values` | Returns the requested campaign analytics values data *Rate limits*: Burst: `1/s` Steady: `2/m` Daily: `225/d` **Scopes:** `campaigns:read` | | `query-flow-series` | Returns time-series analytics data for flows, enabling performance tracking over time intervals. | | `query-flow-values` | Returns the requested flow analytics values data *Rate limits*: Burst: `1/s` Steady: `2/m` Daily: `225/d` **Scopes:** `flows:read` | | `query-metric-aggregates` | The Klaviyo endpoint fetches metric events, handling JSON requests for custom data queries, sorting, and filtering; offers grouping and time-based... | | `remove-profile-from-list` | Remove profiles from a Klaviyo list by profile IDs or email addresses. | | `request-profile-deletion` | To delete a profile, use only one identifier: email, phone number, or ID. | | `spawn-bulk-profile-import-job` | Initiate a job to create/update a batch of profiles, up to 10,000 with a max size of 5MB per request. | | `spawn-coupon-code-bulk-create-job` | Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. | | `spawn-create-categories-job` | Create bulk job for up to 100 catalog categories with a 5MB size limit and a max of 500 concurrent jobs. | | `spawn-create-items-job` | Create batches of up to 100 catalog items with a 5MB size limit using the bulk job, which allows 500 concurrent jobs. | | `spawn-create-variants-job` | Initiate a job to bulk create up to 100 catalog variants, with a 5MB payload size limit. | | `spawn-delete-categories-job` | Delete multiple catalog categories in bulk, with a limit of 100 per request and a 5MB payload size. | | `spawn-delete-items-job` | Delete batches of catalog items with a bulk job, max 100 items/request, 5MB size limit, and up to 500 concurrent jobs. | | `spawn-delete-variants-job` | Delete multiple catalog variants with a bulk job, max 100 per request, 5MB size limit. | | `spawn-update-categories-job` | Create a job to bulk update up to 100 categories, with a 5MB size limit and a maximum of 500 concurrent jobs. | | `spawn-update-items-job` | You can bulk update up to 100 catalog items with a 5MB payload limit. | | `spawn-update-variants-job` | Create a job to bulk update up to 100 catalog variants with a 5MB payload limit. | | `subscribe-profiles` | The API supports double opt-in for marketing, with 'historical\_import' bypassing consent. | | `suppress-profiles` | Suppress profiles by email, segment, or list ID to stop email marketing, regardless of consent. | | `unregister-client-push-token` | This endpoint unsubscribes a push token, for use with Klaviyo's mobile SDKs and a public API key. | | `unsubscribe-profiles` | Opt-out profiles from email or SMS marketing. Unsubscribe up to 100 profiles at a time with burst (75/s) and steady (700/m) rate limits. | | `unsubscribe-profiles-bulk` | Tool to unsubscribe one or more profiles from a Klaviyo list. | | `unsuppress-profiles` | Remove 'USER\_SUPPRESSED' blocks on profiles manually via email, segment, or list ID. | | `unsuppress-profiles-bulk` | Tool to unsuppress one or more profiles from email marketing by email address. | | `update-campaign` | Update a campaign with the specified attributes. This action allows you to modify campaign settings including name, audiences, and send strategy. | | `update-campaign-message` | Update a campaign message *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` | | `update-catalog-category` | Update a catalog category with the given category ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `update-catalog-category-relationships` | Tool to update item relationships for a catalog category. Replaces all existing item relationships with the provided list. | | `update-catalog-category-relationships-items` | Update item relationships for the given category ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `update-catalog-item` | Update a catalog item with the given item ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `update-catalog-item-relationships-categories` | Update catalog category relationships for the given item ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `update-catalog-variant` | Update a catalog item variant with the given variant ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write` | | `update-coupon` | Update an existing coupon's properties. Currently, only the coupon description can be updated. | | `update-coupon-code` | Updates a coupon code specified by the given identifier synchronously. | | `update-flow-status` | Update the status of a flow with the given flow ID, and all actions in that flow. | | `update-image` | Update the image with the given image ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `images:write` | | `update-list` | Update the name of a list with the given list ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:write` | | `update-profile` | Update profiles with the provided ID. Setting fields to `null` clears them; omitting fields retains existing data. | | `update-segment` | Update a segment with the given segment ID. *Rate limits*: Burst: `1/s` Steady: `15/m` Daily: `100/d` **Scopes:** `segments:write` | | `update-tag` | Update the tag with the given tag ID. Only a tag's `name` can be changed. | | `update-tag-group` | Update the tag group with the given tag group ID. Only a tag group's `name` can be changed. | | `update-template` | Update an existing email template by ID. Supports updating name, HTML content, and plaintext content. | | `update-webhook` | Update the webhook with the given ID. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `webhooks:write` | | `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... | | `upload-image-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*... | [Open Klaviyo in the console →](https://app.boxd.sh/integrations/detail/klaviyo)