# 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

- **Category:** marketing automation
- **Auth:** API_KEY, OAUTH2
- **Tools:** 231
- **Triggers:** 0
- **Slug:** `KLAVIYO`
- **Version:** 20260217_00

## Tools

### Add Profile to List

**Slug:** `KLAVIYO_ADD_PROFILE_TO_LIST`

Add profiles to a Klaviyo list by profile IDs or email addresses. This action subscribes profiles to a marketing list, which is ideal for giving marketing consent. You can add up to 1000 profiles per call using either their Klaviyo profile IDs or email addresses. Rate limits: 10/s burst, 150/m steady. Required scopes: `lists:write` and `profiles:write`. Preconditions: - Either profile_ids or emails must be provided (not both) - Maximum 1000 profiles per call - Email addresses must be valid format - The list must exist and be accessible

### Assign campaign message template

**Slug:** `KLAVIYO_ASSIGN_CAMPAIGN_MESSAGE_TEMPLATE`

Creates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`

### Bulk create client events

**Slug:** `KLAVIYO_BULK_CREATE_CLIENT_EVENTS`

Use the client-side endpoint with a public API key to track profile activity. It accepts up to 1000 events/request with rates of 10/s burst and 150/m steady. For server-side, use the bulk create event endpoint.

### Bulk create events

**Slug:** `KLAVIYO_BULK_CREATE_EVENTS`

Bulk create events for multiple profiles in a single request. Accepts up to 1,000 events with a 5MB max payload. Each event requires a profile identifier (email, phone_number, or external_id) and a metric name. Events are processed asynchronously; a 202 response indicates acceptance, not completion. Rate limits: 10/s burst, 150/min steady.

### Create back in stock subscription

**Slug:** `KLAVIYO_CREATE_BACK_IN_STOCK_SUBSCRIPTION`

Use the server-side endpoint to subscribe to restock alerts, following the Back in Stock API guide. For client-side, use the POST endpoint provided. Rate limits: 350/s burst and 3500/m steady. Required scopes: catalogs:write, profiles:write.

### Create campaign

**Slug:** `KLAVIYO_CREATE_CAMPAIGN`

Creates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`

### Create campaign clone

**Slug:** `KLAVIYO_CREATE_CAMPAIGN_CLONE`

Clones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`

### Create Campaign Recipient Estimation Job

**Slug:** `KLAVIYO_CREATE_CAMPAIGN_RECIPIENT_ESTIMATION_JOB`

Start an asynchronous task to estimate the number of recipients for a campaign. This action creates a background job that calculates how many profiles would receive the campaign based on its current audience settings. Use the job ID returned to track progress with the 'Get Campaign Recipient Estimation Job' action, and get the final count via 'Get Campaign Recipient Estimation' action. Rate limits: 10/s burst, 150/m steady. Required scope: `campaigns:write`. Preconditions: - Valid API key with campaigns:write scope - Campaign ID must exist and be accessible - Campaign must have audience settings configured

### Create campaign send job

**Slug:** `KLAVIYO_CREATE_CAMPAIGN_SEND_JOB`

Trigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`

### Create catalog category

**Slug:** `KLAVIYO_CREATE_CATALOG_CATEGORY`

Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Create catalog category relationships items

**Slug:** `KLAVIYO_CREATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMS`

Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Create catalog item

**Slug:** `KLAVIYO_CREATE_CATALOG_ITEM`

Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Create catalog item relationships categories

**Slug:** `KLAVIYO_CREATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIES`

Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Create catalog variant

**Slug:** `KLAVIYO_CREATE_CATALOG_VARIANT`

Create a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Create client back in stock subscription

**Slug:** `KLAVIYO_CREATE_CLIENT_BACK_IN_STOCK_SUBSCRIPTION`

Use the endpoint for client-side back in stock notifications with a public API key. For server-side, use POST /api/back-in-stock-subscriptions. Limits are 350 requests per second and 3500 per minute. Requires 'catalogs:write' and 'profiles:write' scopes.

### Create Client Event

**Slug:** `KLAVIYO_CREATE_CLIENT_EVENT`

Create a client-side event in Klaviyo to track user interactions. This action creates events using Klaviyo's client-side API, which is designed for tracking user interactions from web browsers or mobile apps. It associates events with profiles and can update profile information at the same time. Rate limits: 350/s, 3500/m. Required scope: `events:write`. Preconditions: - At least one profile identifier (email, phone_number, external_id, or anonymous_id) must be provided - Metric name must be less than 128 characters - Email must be valid format if provided - Phone number must be in E.164 format if provided

### Create client subscription

**Slug:** `KLAVIYO_CREATE_CLIENT_SUBSCRIPTION`

Endpoint manages email/SMS opt-ins using consent and requires public API key for client use. Allows single-channel with details. Rate limit: 100/s burst, 700/m steady, under 'subscriptions:write'.

### Create coupon

**Slug:** `KLAVIYO_CREATE_COUPON`

Creates a new coupon.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `coupons:write`

### Create coupon code

**Slug:** `KLAVIYO_CREATE_COUPON_CODE`

Synchronously creates a coupon code for the given coupon.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:write`

### Create event

**Slug:** `KLAVIYO_CREATE_EVENT`

Create or update a profile event with minimum identifiers and metric name. Success means validation, not completion. Burst limit: 350/s, Steady: 3500/m. Scope required: `events:write`.

### Create list

**Slug:** `KLAVIYO_CREATE_LIST`

Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`<br>Daily: `100/d` **Scopes:** `lists:write`

### Create or update client profile

**Slug:** `KLAVIYO_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. Burst rate is 350 requests/sec and 3500 requests/min with 'profiles:write' access.

### Create or update client push token

**Slug:** `KLAVIYO_CREATE_OR_UPDATE_CLIENT_PUSH_TOKEN`

This endpoint for mobile SDKs (iOS & Android) creates/updates push tokens using a public API key. Push notifications must be enabled. For migrating tokens use the server-side POST endpoint. Rate limits are 3/s burst, 150/m steady.

### Create or Update Profile

**Slug:** `KLAVIYO_CREATE_OR_UPDATE_PROFILE`

Create or update a profile in Klaviyo with the given attributes. This action allows you to create a new profile or update an existing one if it already exists (based on email or other identifiers). Returns 201 for creation, 200 for update. Empty fields are cleared with `null`; omitted fields remain unchanged. Rate limits: 75/s burst, 700/m steady. Required scope: `profiles:write`. Preconditions: - At least one identifier (email, phone_number, external_id, or anonymous_id) must be provided - Email must be in valid format if provided - Phone number must be in E.164 format if provided

### Create or update push token

**Slug:** `KLAVIYO_CREATE_OR_UPDATE_PUSH_TOKEN`

Create or update a push token for mobile push notifications. This server-side endpoint is used for migrating push tokens from other platforms to Klaviyo. For creating tokens from mobile devices, use Klaviyo's mobile SDKs instead. Prerequisites: Push notifications must be enabled for the Klaviyo account. Required fields: - data__type: Must be 'push-token' - data__attributes__token: The push token from APNS or FCM - data__attributes__platform: 'ios' or 'android' - data__attributes__vendor: 'apns' (iOS) or 'fcm' (Android) - data__attributes__profile__data__type: Must be 'profile' - At least one profile identifier (email, phone_number, external_id, anonymous_id, or profile id) Rate limits: 75/s burst, 700/m steady. Max payload: 100KB. Requires scopes: profiles:write, push-tokens:write

### Create profile

**Slug:** `KLAVIYO_CREATE_PROFILE`

Create a new profile.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`

### Create segment

**Slug:** `KLAVIYO_CREATE_SEGMENT`

Create a segment.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `segments:write`

### Create tag

**Slug:** `KLAVIYO_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. Rate limits are 3/s burst and 60/min steady. Tag: #TagCreationLimitAndRate

### Create tag group

**Slug:** `KLAVIYO_CREATE_TAG_GROUP`

Create tag groups up to 50 per account, defaulting to non-exclusive unless specified. Related resources can have multiple non-exclusive tags but only one if exclusive. Rate limits: 3/s burst, 60/m steady. Scopes needed: tags:read, tags:write.

### Create tag relationships campaigns

**Slug:** `KLAVIYO_CREATE_TAG_RELATIONSHIPS_CAMPAIGNS`

Summary: Link a tag to campaigns, ensuring a limit of 100 tags per campaign. Campaign IDs should be sent via request body. Rate limit: 3/s, 60/m. Required scopes: campaigns:write, tags:write. Tag: #CampaignTaggingLimits

### Associate Tag With Flows

**Slug:** `KLAVIYO_CREATE_TAG_RELATIONSHIPS_FLOWS`

Associate a tag with one or more flows in Klaviyo. This creates relationships between a tag (identified by its UUID) and flows (identified by their IDs). A flow can have up to 100 tags associated with it. Returns HTTP 204 No Content on success. Rate limits: 3/s burst, 60/m steady. Scopes required: flows:write, tags:write

### Associate Tag With Lists

**Slug:** `KLAVIYO_CREATE_TAG_RELATIONSHIPS_LISTS`

Associate a tag with one or more lists in Klaviyo. This creates relationships between a tag (identified by its UUID) and lists (identified by their IDs). A list can have up to 100 tags associated with it. Returns HTTP 204 No Content on success. Rate limits: 3/s burst, 60/m steady. Scopes required: tags:write

### Create tag relationships segments

**Slug:** `KLAVIYO_CREATE_TAG_RELATIONSHIPS_SEGMENTS`

Summary: Set tag associations with segments using the request body, limited to one tag per segment and up to 100 tags per segment. Rate limits are three requests per second and sixty per minute. Tags: segments:write, tags:write

### Create template

**Slug:** `KLAVIYO_CREATE_TEMPLATE`

Summary: Custom HTML templates can be created unless an account reaches 1,000 template limit. Use sparse fieldsets to request specific fields. Rate limits are 10 per second and 150 per minute. Requires 'templates:write' scope.

### Create template clone

**Slug:** `KLAVIYO_CREATE_TEMPLATE_CLONE`

Clone a template by its ID, but cloning fails if account has 1,000+ templates. API limit: 1,000 templates. Rate limits are 10 per second and 150 per minute. Requires `templates:write` scope.

### Create template render

**Slug:** `KLAVIYO_CREATE_TEMPLATE_RENDER`

Render an email template with specific context and sparse fieldsets, then get HTML/plain text. Rate limit: 3/s burst, 60/m steady. Scope: templates:read.

### Create webhook

**Slug:** `KLAVIYO_CREATE_WEBHOOK`

Create a new Webhook to receive real-time notifications when specific events occur in Klaviyo (e.g., email clicks, SMS sent). Rate limits: Burst: 1/s, Steady: 15/m Required scopes: webhooks:write, events:read (for event-based topics) Note: Each Klaviyo account can have a maximum of 10 webhooks.

### Delete campaign

**Slug:** `KLAVIYO_DELETE_CAMPAIGN`

Delete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`

### Delete catalog category

**Slug:** `KLAVIYO_DELETE_CATALOG_CATEGORY`

Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Delete catalog category relationships items

**Slug:** `KLAVIYO_DELETE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMS`

Delete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Delete catalog item

**Slug:** `KLAVIYO_DELETE_CATALOG_ITEM`

Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Delete catalog item relationships categories

**Slug:** `KLAVIYO_DELETE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIES`

Delete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Delete catalog variant

**Slug:** `KLAVIYO_DELETE_CATALOG_VARIANT`

Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Delete coupon

**Slug:** `KLAVIYO_DELETE_COUPON`

Delete the coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `coupons:write`

### Delete coupon code

**Slug:** `KLAVIYO_DELETE_COUPON_CODE`

Deletes a coupon code specified by the given identifier synchronously. If a profile has been assigned to the coupon code, an exception will be raised<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:write`

### Delete flow

**Slug:** `KLAVIYO_DELETE_FLOW`

Delete a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`

### Delete list

**Slug:** `KLAVIYO_DELETE_LIST`

Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write`

### Delete segment

**Slug:** `KLAVIYO_DELETE_SEGMENT`

Delete a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write`

### Delete tag

**Slug:** `KLAVIYO_DELETE_TAG`

Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`

### Delete tag group

**Slug:** `KLAVIYO_DELETE_TAG_GROUP`

Delete a specified tag group and its contents; associated resource links will be removed. The default group is undeletable. Rate limits: 3/s burst, 60/m steady. Requires tags:read and tags:write permissions.

### Delete tag relationships campaigns

**Slug:** `KLAVIYO_DELETE_TAG_RELATIONSHIPS_CAMPAIGNS`

Disconnect a tag from campaigns using the campaign ID(s) in the request body. Rate limits: 3 requests/second, 60 requests/minute. Required scopes: campaigns:write, tags:write.

### Delete tag relationships flows

**Slug:** `KLAVIYO_DELETE_TAG_RELATIONSHIPS_FLOWS`

Remove a tag's association with one or more flows. Use the request body to pass in the ID(s) of the flows(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write`

### Delete tag relationships lists

**Slug:** `KLAVIYO_DELETE_TAG_RELATIONSHIPS_LISTS`

Remove a tag's association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:write` `tags:write`

### Delete tag relationships segments

**Slug:** `KLAVIYO_DELETE_TAG_RELATIONSHIPS_SEGMENTS`

Use the request body to de-associate a tag from specified segment IDs. Rate limits are 3 requests/sec and 60 requests/min. Required scopes are 'segments:write' and 'tags:write'.

### Delete template

**Slug:** `KLAVIYO_DELETE_TEMPLATE`

Permanently delete a template from your Klaviyo account using its unique template ID. This action is destructive and cannot be undone. Rate limits: Burst 10/s, Steady 150/m. Requires 'templates:write' scope.

### Delete webhook

**Slug:** `KLAVIYO_DELETE_WEBHOOK`

Permanently delete a webhook subscription from your Klaviyo account. This action removes the webhook configuration, stopping all future event notifications to the webhook's endpoint URL. This operation is irreversible. **Requirements:** - Advanced KDP (Klaviyo Data Platform) must be enabled on your account - API key must have `webhooks:write` scope **Rate limits:** Burst: 1/s, Steady: 15/m **Returns:** HTTP 204 No Content on successful deletion (empty response body).

### Get account

**Slug:** `KLAVIYO_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.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`

### Get accounts

**Slug:** `KLAVIYO_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. Rate limit: 1 request/second, 15 requests/minute. Scope required: `accounts:read`.

### Get bulk profile import job

**Slug:** `KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB`

Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`

### Get bulk profile import job errors

**Slug:** `KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_ERRORS`

Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`

### Get bulk profile import job lists

**Slug:** `KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_LISTS`

Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`

### Get bulk profile import job profiles

**Slug:** `KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_PROFILES`

Get profiles for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`

### Get bulk profile import job relationships lists

**Slug:** `KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_LISTS`

Get list relationship for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`

### Get bulk profile import job relationships profiles

**Slug:** `KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_PROFILES`

Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`

### Get bulk profile import jobs

**Slug:** `KLAVIYO_GET_BULK_PROFILE_IMPORT_JOBS`

Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`

### Get Campaign

**Slug:** `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, audience settings, send strategy, and optionally related messages and tags. Rate limits: 10/s burst, 150/m steady. Required scope: `campaigns:read`. Preconditions: - Valid API key with campaigns:read scope - Campaign ID must exist and be accessible

### Get campaign campaign messages

**Slug:** `KLAVIYO_GET_CAMPAIGN_CAMPAIGN_MESSAGES`

Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`

### Get campaign message

**Slug:** `KLAVIYO_GET_CAMPAIGN_MESSAGE`

Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`

### Get campaign message campaign

**Slug:** `KLAVIYO_GET_CAMPAIGN_MESSAGE_CAMPAIGN`

Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`

### Get campaign message relationships campaign

**Slug:** `KLAVIYO_GET_CAMPAIGN_MESSAGE_RELATIONSHIPS_CAMPAIGN`

Returns the ID of the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`

### Get campaign message relationships template

**Slug:** `KLAVIYO_GET_CAMPAIGN_MESSAGE_RELATIONSHIPS_TEMPLATE`

Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`

### Get campaign message template

**Slug:** `KLAVIYO_GET_CAMPAIGN_MESSAGE_TEMPLATE`

Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`

### Get campaign recipient estimation

**Slug:** `KLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATION`

Get estimated recipients for a given campaign ID using `Create Campaign Recipient Estimation Job`. Rate limits are 10/s burst and 150/m steady. Required scope: `campaigns:read`.

### Get campaign recipient estimation job

**Slug:** `KLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATION_JOB`

Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`

### Get campaign relationships campaign messages

**Slug:** `KLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_CAMPAIGN_MESSAGES`

Returns the IDs of all messages associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`

### Get campaign relationships tags

**Slug:** `KLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_TAGS`

Returns the IDs of all tags associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`

### Get Campaigns

**Slug:** `KLAVIYO_GET_CAMPAIGNS`

Retrieve campaigns from your Klaviyo account. This action allows you to fetch campaigns with optional filtering and sorting. Klaviyo requires specifying a channel (email or sms) to list campaigns. You can add additional filters for status, name, creation date, and other attributes. Results are paginated with a default of 10 campaigns per page. Rate limits: 10/s burst, 150/m steady. Required scope: `campaigns:read`. Preconditions: - Valid API key with campaigns:read scope - Channel must be specified (email or sms) - Additional filter syntax must be valid if provided

### Get campaign send job

**Slug:** `KLAVIYO_GET_CAMPAIGN_SEND_JOB`

Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`

### Get campaign tags

**Slug:** `KLAVIYO_GET_CAMPAIGN_TAGS`

Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`

### Get catalog categories

**Slug:** `KLAVIYO_GET_CATALOG_CATEGORIES`

Retrieve up to 100 account catalog categories, sortable by creation date. Only `$custom` integration and `$default` catalog types supported. Rate limits are 350/s and 3500/m. Requires `catalogs:read` scope.

### Get catalog category

**Slug:** `KLAVIYO_GET_CATALOG_CATEGORY`

Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get catalog category items

**Slug:** `KLAVIYO_GET_CATALOG_CATEGORY_ITEMS`

Retrieve up to 100 sorted items per request from a category using the category ID. Sort by 'created' field. Rate limits are 350/s burst and 3500/m steady. Requires 'catalogs:read' scope.

### Get catalog category relationships items

**Slug:** `KLAVIYO_GET_CATALOG_CATEGORY_RELATIONSHIPS_ITEMS`

Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get catalog item

**Slug:** `KLAVIYO_GET_CATALOG_ITEM`

Get a specific catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get catalog item categories

**Slug:** `KLAVIYO_GET_CATALOG_ITEM_CATEGORIES`

Retrieve the catalog categories for an item by ID, sorted by 'created' date, with a 100-category maximum per request. Rate limits: 350/s burst, 3500/m steady. Requires 'catalogs:read' scope.

### Get catalog item relationships categories

**Slug:** `KLAVIYO_GET_CATALOG_ITEM_RELATIONSHIPS_CATEGORIES`

Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get catalog items

**Slug:** `KLAVIYO_GET_CATALOG_ITEMS`

Retrieve up to 100 sorted catalog items per account, with `$custom` integration and `$default` type. Rate limits: 350/s burst, 3500/m steady. Scope required: `catalogs:read`.

### Get catalog item variants

**Slug:** `KLAVIYO_GET_CATALOG_ITEM_VARIANTS`

Retrieve up to 100 variants per request for a specific item ID, sortable by creation date. Rate limits are 350/s burst and 3500/m steady. Requires 'catalogs:read' scope.

### Get catalog variant

**Slug:** `KLAVIYO_GET_CATALOG_VARIANT`

Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get catalog variants

**Slug:** `KLAVIYO_GET_CATALOG_VARIANTS`

Retrieve up to 100 account variants per request, sortable by creation date. Supports only `$custom` integration and `$default` catalog types. Rate limits are 350/s burst and 3500/m steady. Requires `catalogs:read` scope.

### Get coupon

**Slug:** `KLAVIYO_GET_COUPON`

Get a specific coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`

### Get coupon code

**Slug:** `KLAVIYO_GET_COUPON_CODE`

Returns a Coupon Code specified by the given identifier.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:read`

### Get coupon code bulk create job

**Slug:** `KLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOB`

Get a coupon code bulk create job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`

### Get coupon code bulk create jobs

**Slug:** `KLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOBS`

Get all coupon code bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`

### Get coupon code relationships coupon

**Slug:** `KLAVIYO_GET_COUPON_CODE_RELATIONSHIPS_COUPON`

Gets a list of coupon code relationships associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`

### Get coupon codes

**Slug:** `KLAVIYO_GET_COUPON_CODES`

Obtains coupon codes using necessary coupon or profile filters. Rate limits: 350/s, 3500/m. Requires 'coupon-codes:read' scope.

### Get coupon codes for coupon

**Slug:** `KLAVIYO_GET_COUPON_CODES_FOR_COUPON`

Gets a list of coupon codes associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`

### Get coupon for coupon code

**Slug:** `KLAVIYO_GET_COUPON_FOR_COUPON_CODE`

Get the coupon associated with a given coupon code ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`

### Get Coupon Relationships Coupon Codes

**Slug:** `KLAVIYO_GET_COUPON_RELATIONSHIPS_COUPON_CODES`

Retrieves the coupon code relationships (resource identifiers) for a given coupon. Returns a list of coupon code IDs associated with the specified coupon, along with pagination links for navigating large result sets. Rate limits: Burst: 75/s, Steady: 700/m Required scopes: coupons:read

### Get coupons

**Slug:** `KLAVIYO_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).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`

### Get create categories job

**Slug:** `KLAVIYO_GET_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`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get create categories jobs

**Slug:** `KLAVIYO_GET_CREATE_CATEGORIES_JOBS`

Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get create items job

**Slug:** `KLAVIYO_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`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get create items jobs

**Slug:** `KLAVIYO_GET_CREATE_ITEMS_JOBS`

Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get create variants job

**Slug:** `KLAVIYO_GET_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`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get create variants jobs

**Slug:** `KLAVIYO_GET_CREATE_VARIANTS_JOBS`

Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get delete categories job

**Slug:** `KLAVIYO_GET_DELETE_CATEGORIES_JOB`

Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get delete categories jobs

**Slug:** `KLAVIYO_GET_DELETE_CATEGORIES_JOBS`

Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get delete items job

**Slug:** `KLAVIYO_GET_DELETE_ITEMS_JOB`

Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get delete items jobs

**Slug:** `KLAVIYO_GET_DELETE_ITEMS_JOBS`

Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get delete variants job

**Slug:** `KLAVIYO_GET_DELETE_VARIANTS_JOB`

Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get delete variants jobs

**Slug:** `KLAVIYO_GET_DELETE_VARIANTS_JOBS`

Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get event

**Slug:** `KLAVIYO_GET_EVENT`

Get an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `events:read`

### Get event metric

**Slug:** `KLAVIYO_GET_EVENT_METRIC`

Get the metric for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` `metrics:read`

### Get event profile

**Slug:** `KLAVIYO_GET_EVENT_PROFILE`

Get the profile associated with an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` `profiles:read`

### Get event relationships metric

**Slug:** `KLAVIYO_GET_EVENT_RELATIONSHIPS_METRIC`

Get a list of related Metrics for an Event<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` `metrics:read`

### Get event relationships profile

**Slug:** `KLAVIYO_GET_EVENT_RELATIONSHIPS_PROFILE`

Get profile [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` `profiles:read`

### Get events

**Slug:** `KLAVIYO_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.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read`

### Get flow

**Slug:** `KLAVIYO_GET_FLOW`

Get a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`

### Get flow action

**Slug:** `KLAVIYO_GET_FLOW_ACTION`

Get a flow action from a flow with the given flow action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`

### Get flow action for message

**Slug:** `KLAVIYO_GET_FLOW_ACTION_FOR_MESSAGE`

Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`

### Get flow action messages

**Slug:** `KLAVIYO_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 `page[size]` and `page[number]`. Rate limits: 3/s burst, 60/m steady. Scope required: `flows:read`.

### Get Parent Flow for Flow Action

**Slug:** `KLAVIYO_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 to identify which flow contains the specified action. Use cases: - Determine which flow a specific action belongs to - Navigate from an action to its parent flow Rate limits: Burst: 3/s, Steady: 60/m Required scope: flows:read

### Get flow action relationships messages

**Slug:** `KLAVIYO_GET_FLOW_ACTION_RELATIONSHIPS_MESSAGES`

Retrieves up to 50 flow message relationships per request for a specified flow action ID, with cursor pagination. Rate limits: 3/s burst, 60/min steady. Requires `flows:read` scope.

### Get flow flow actions

**Slug:** `KLAVIYO_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 pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`

### Get flow for flow action

**Slug:** `KLAVIYO_GET_FLOW_FOR_FLOW_ACTION`

Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`

### Get flow message

**Slug:** `KLAVIYO_GET_FLOW_MESSAGE`

Get the flow message of a flow with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`

### Get flow message relationships action

**Slug:** `KLAVIYO_GET_FLOW_MESSAGE_RELATIONSHIPS_ACTION`

Get the flow action relationship for a specific flow message. This returns the parent flow action that contains the specified flow message (e.g., the SEND_EMAIL or SEND_SMS action). Requires a valid flow message ID which can be obtained from GET /api/flow-actions/{id}/flow-messages/. Rate limits: Burst 3/s, Steady 60/m. Required scope: flows:read

### Get flow message relationships template

**Slug:** `KLAVIYO_GET_FLOW_MESSAGE_RELATIONSHIPS_TEMPLATE`

Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`

### Get flow message template

**Slug:** `KLAVIYO_GET_FLOW_MESSAGE_TEMPLATE`

Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`

### Get flow relationships flow actions

**Slug:** `KLAVIYO_GET_FLOW_RELATIONSHIPS_FLOW_ACTIONS`

Retrieve all flow action relationships for a specific flow ID, sortable by `id`, `status`, `created`, `updated`. Refine with filters, max 50 per page, paginated by `page[size]` and `page[number]`. Rate limits: Burst 3/s, Steady 60/m. Scope: `flows:read`.

### Get flow relationships tags

**Slug:** `KLAVIYO_GET_FLOW_RELATIONSHIPS_TAGS`

Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`

### Get flows

**Slug:** `KLAVIYO_GET_FLOWS`

Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`

### Get flow tags

**Slug:** `KLAVIYO_GET_FLOW_TAGS`

Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`

### Get form

**Slug:** `KLAVIYO_GET_FORM`

Get the form with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`

### Get form for form version

**Slug:** `KLAVIYO_GET_FORM_FOR_FORM_VERSION`

Get the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`

### Get form id for form version

**Slug:** `KLAVIYO_GET_FORM_ID_FOR_FORM_VERSION`

Get the ID of the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`

### Get forms

**Slug:** `KLAVIYO_GET_FORMS`

Get all forms in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`

### Get form version

**Slug:** `KLAVIYO_GET_FORM_VERSION`

Retrieve detailed information about a specific form version by its ID. Form versions represent different variations of a Klaviyo sign-up form. A form may have multiple versions for A/B testing (multiple live variations) or draft/live combinations during editing. Use this endpoint to get the full configuration including form type, status, steps, styling, triggers, and other settings. Rate limits: Burst 3/s, Steady 60/m. Required scope: forms:read

### Get image

**Slug:** `KLAVIYO_GET_IMAGE`

Get the image with the given image ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read`

### Get images

**Slug:** `KLAVIYO_GET_IMAGES`

Get all images in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read`

### Get list

**Slug:** `KLAVIYO_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. See developer guide for details.

### Get list profiles

**Slug:** `KLAVIYO_GET_LIST_PROFILES`

Retrieve profiles in a list by ID, filterable by email/phone/push token/join date, sortable by join date. Regular rate limit: 75/s, 700/m; with predictive analytics: 10/s, 150/m. Details at Klaviyo guide. Scopes required: lists:read, profiles:read.

### Get list relationships profiles

**Slug:** `KLAVIYO_GET_LIST_RELATIONSHIPS_PROFILES`

Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:read` `profiles:read`

### Get list relationships tags

**Slug:** `KLAVIYO_GET_LIST_RELATIONSHIPS_TAGS`

Returns the tag IDs of all tags associated with the given list.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`

### Get Lists

**Slug:** `KLAVIYO_GET_LISTS`

Retrieve marketing lists from your Klaviyo account. This action allows you to fetch lists with optional filtering and sorting. You can filter by name, creation date, and other attributes. Results are paginated with a default of 10 lists per page. Rate limits: 75/s burst, 700/m steady. Required scope: `lists:read`. Preconditions: - Valid API key with lists:read scope - Filter syntax must be valid if provided

### Get list tags

**Slug:** `KLAVIYO_GET_LIST_TAGS`

Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`

### Get metric

**Slug:** `KLAVIYO_GET_METRIC`

Get a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read`

### Get metrics

**Slug:** `KLAVIYO_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 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read`

### Get profile

**Slug:** `KLAVIYO_GET_PROFILE`

Get the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read`

### Get profile lists

**Slug:** `KLAVIYO_GET_PROFILE_LISTS`

Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`

### Get profile relationships lists

**Slug:** `KLAVIYO_GET_PROFILE_RELATIONSHIPS_LISTS`

Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`

### Get profile relationships segments

**Slug:** `KLAVIYO_GET_PROFILE_RELATIONSHIPS_SEGMENTS`

Get segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`

### Get Profiles

**Slug:** `KLAVIYO_GET_PROFILES`

Retrieve profiles from your Klaviyo account. This action allows you to fetch profiles with optional filtering and sorting. You can filter by email, external_id, creation date, and other attributes. Results are paginated with a configurable page size. Rate limits: 75/s burst, 700/m steady (lower with predictive_analytics). Required scope: `profiles:read`. Preconditions: - Valid API key with profiles:read scope - Filter syntax must be valid if provided - Page size must be between 1 and 100

### Get profile segments

**Slug:** `KLAVIYO_GET_PROFILE_SEGMENTS`

Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`

### Get segment

**Slug:** `KLAVIYO_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. For details, visit the provided guide. Required scope: `segments:read`.

### Get segment profiles

**Slug:** `KLAVIYO_GET_SEGMENT_PROFILES`

Retrieve profiles in a segment by ID, filtering by email, phone, token, or join date, and sorting by join date. Rate limit: 75/s burst, 700/m steady. Requires profiles:read and segments:read scopes.

### Get segment relationships profiles

**Slug:** `KLAVIYO_GET_SEGMENT_RELATIONSHIPS_PROFILES`

Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read` `segments:read`

### Get Segment Tag Relationships

**Slug:** `KLAVIYO_GET_SEGMENT_RELATIONSHIPS_TAGS`

Retrieves all tag IDs associated with a given segment. Returns tag resource identifiers (type and id) for each tag linked to the segment. Use the related link in the response to fetch full tag details. Rate limits: Burst: 3/s, Steady: 60/m Required scopes: segments:read, tags:read

### Get segments

**Slug:** `KLAVIYO_GET_SEGMENTS`

Fetch segments from an account with filters like `name`, `created`, and `updated`. Max 10 results/page. Rate limits are 75/s burst, 700/m steady. Requires `segments:read` scope.

### Get segment tags

**Slug:** `KLAVIYO_GET_SEGMENT_TAGS`

Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`

### Get tag

**Slug:** `KLAVIYO_GET_TAG`

Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`

### Get tag group

**Slug:** `KLAVIYO_GET_TAG_GROUP`

Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`

### Get tag group relationships tags

**Slug:** `KLAVIYO_GET_TAG_GROUP_RELATIONSHIPS_TAGS`

Returns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`

### Get tag groups

**Slug:** `KLAVIYO_GET_TAG_GROUPS`

Retrieve up to 25 tag groups per account, sortable/filterable by specific attributes. Default group included. Supports cursor pagination and adheres to rate limits of 3 requests per second and 60 per minute. Requires `tags:read` scope.

### Get tag group tags

**Slug:** `KLAVIYO_GET_TAG_GROUP_TAGS`

Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`

### Get tag relationships campaigns

**Slug:** `KLAVIYO_GET_TAG_RELATIONSHIPS_CAMPAIGNS`

Returns the IDs of all campaigns associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`

### Get tag relationships flows

**Slug:** `KLAVIYO_GET_TAG_RELATIONSHIPS_FLOWS`

Returns the IDs of all flows associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`

### Get tag relationships lists

**Slug:** `KLAVIYO_GET_TAG_RELATIONSHIPS_LISTS`

Returns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`

### Get tag relationships segments

**Slug:** `KLAVIYO_GET_TAG_RELATIONSHIPS_SEGMENTS`

Returns the IDs of all segments associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`

### Get tag relationships tag group

**Slug:** `KLAVIYO_GET_TAG_RELATIONSHIPS_TAG_GROUP`

Returns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`

### Get tags

**Slug:** `KLAVIYO_GET_TAGS`

Retrieve up to 50 account tags at once, filterable/sortable by name or id, with cursor pagination. Rate limits: 3/s burst, 60/m steady. Requires `tags:read` scope.

### Get tag tag group

**Slug:** `KLAVIYO_GET_TAG_TAG_GROUP`

Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`

### Get template

**Slug:** `KLAVIYO_GET_TEMPLATE`

Get a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read`

### Get templates

**Slug:** `KLAVIYO_GET_TEMPLATES`

Retrieve account templates with sorting options (`id`, `name`, `created`, `updated`). Limit of 10 results per page, rate limits at 10/s burst and 150/m steady. Requires `templates:read` scope.

### Get update categories job

**Slug:** `KLAVIYO_GET_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`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get update categories jobs

**Slug:** `KLAVIYO_GET_UPDATE_CATEGORIES_JOBS`

Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get update items job

**Slug:** `KLAVIYO_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`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get update items jobs

**Slug:** `KLAVIYO_GET_UPDATE_ITEMS_JOBS`

Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get update variants job

**Slug:** `KLAVIYO_GET_UPDATE_VARIANTS_JOB`

Retrieve a catalog variant bulk update job by its ID. Returns job status, progress counts, completion timestamps, and any errors that occurred. Use the `include` parameter with 'variants' to get full catalog variant objects. Jobs expire after 7 days. Rate limits: Burst 350/s, Steady 3500/m. Requires `catalogs:read` scope.

### Get update variants jobs

**Slug:** `KLAVIYO_GET_UPDATE_VARIANTS_JOBS`

Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`

### Get version ids for form

**Slug:** `KLAVIYO_GET_VERSION_IDS_FOR_FORM`

Get the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`

### Get versions for form

**Slug:** `KLAVIYO_GET_VERSIONS_FOR_FORM`

Get the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`

### Get webhook

**Slug:** `KLAVIYO_GET_WEBHOOK`

Get the webhook with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read`

### Get webhooks

**Slug:** `KLAVIYO_GET_WEBHOOKS`

Get all webhooks in an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read`

### Get webhook topic

**Slug:** `KLAVIYO_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). Use this to get the human-readable name and metadata for a specific topic. Rate limits: Burst 1/s, Steady 15/m. Required scope: webhooks:read

### Get webhook topics

**Slug:** `KLAVIYO_GET_WEBHOOK_TOPICS`

Get all webhook topics in a Klaviyo account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read`

### Merge profiles

**Slug:** `KLAVIYO_MERGE_PROFILES`

Merge one or more source profiles into a destination profile. The source profile(s) data (events, attributes, list memberships) will be transferred to the destination, and the source profile(s) will be deleted. This operation is queued asynchronously and returns HTTP 202 Accepted. Rate limits: 10/s burst, 150/m steady. Requires `profiles:write` scope.

### Query campaign values

**Slug:** `KLAVIYO_QUERY_CAMPAIGN_VALUES`

Returns the requested campaign analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `campaigns:read`

### Query flow series

**Slug:** `KLAVIYO_QUERY_FLOW_SERIES`

Returns time-series analytics data for flows, enabling performance tracking over time intervals. Use this to analyze flow metrics like open rates, click rates, conversions, and delivery statistics. Rate limits: Burst 1/s, Steady 2/m, Daily 225/d. Scopes: flows:read

### Query flow values

**Slug:** `KLAVIYO_QUERY_FLOW_VALUES`

Returns the requested flow analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `flows:read`

### Query metric aggregates

**Slug:** `KLAVIYO_QUERY_METRIC_AGGREGATES`

The Klaviyo endpoint fetches metric events, handling JSON requests for custom data queries, sorting, and filtering; offers grouping and time-based filters; requires adherence to rate limits (3 requests per second, 60 per minute) under 'metrics:read'.

### Remove Profile from List

**Slug:** `KLAVIYO_REMOVE_PROFILE_FROM_LIST`

Remove profiles from a Klaviyo list by profile IDs or email addresses. This action removes profiles from a marketing list without affecting their overall consent status. Use the Unsubscribe Profiles action for complete unsubscribing. You can remove up to 1000 profiles per call. Rate limits: 10/s burst, 150/m steady. Required scopes: `lists:write` and `profiles:write`. Preconditions: - Either profile_ids or emails must be provided (not both) - Maximum 1000 profiles per call - Email addresses must be valid format - The list must exist and be accessible

### Request profile deletion

**Slug:** `KLAVIYO_REQUEST_PROFILE_DELETION`

To delete a profile, use only one identifier: email, phone number, or ID. Requests are asynchronous and can be tracked. Ensure legal compliance; refer to docs. Rate limits: 3 per second, 60 per minute.

### Spawn bulk profile import job

**Slug:** `KLAVIYO_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. Rate limits: 10/s burst, 150/m steady. Requires `lists:write` and `profiles:write` scopes. More info in the Bulk Profile Import API guide.

### Spawn coupon code bulk create job

**Slug:** `KLAVIYO_SPAWN_COUPON_CODE_BULK_CREATE_JOB`

Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max 1000 coupon codes per job. Max 100 jobs queued at once. Rate limits: Burst 75/s, Steady 700/m. Scopes: coupon-codes:write. Returns a job ID that can be used to query the job status via the get_coupon_code_bulk_create_job endpoint.

### Spawn create categories job

**Slug:** `KLAVIYO_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. Rate limits: 75/s burst, 700/m steady. Requires 'catalogs:write' scope.

### Spawn create items job

**Slug:** `KLAVIYO_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. Rate limits are 75/s burst and 700/m steady. Requires `catalogs:write` scope.

### Spawn create variants job

**Slug:** `KLAVIYO_SPAWN_CREATE_VARIANTS_JOB`

Initiate a job to bulk create up to 100 catalog variants, with a 5MB payload size limit. A max of 500 jobs can run concurrently. Rate limits are 75/s burst and 700/m steady. Requires 'catalogs:write' scope.

### Spawn delete categories job

**Slug:** `KLAVIYO_SPAWN_DELETE_CATEGORIES_JOB`

Delete multiple catalog categories in bulk, with a limit of 100 per request and a 5MB payload size. A maximum of 500 concurrent jobs permitted. Rate limits are 75/s burst and 700/min steady. Requires `catalogs:write` scope.

### Spawn delete items job

**Slug:** `KLAVIYO_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. Rate limits are 75/s burst and 700/m steady. Requires `catalogs:write` scope.

### Spawn delete variants job

**Slug:** `KLAVIYO_SPAWN_DELETE_VARIANTS_JOB`

Delete multiple catalog variants with a bulk job, max 100 per request, 5MB size limit. Only 500 jobs can run concurrently. Rate limits: 75/s burst, 700/m steady. Requires `catalogs:write` scope.

### Spawn update categories job

**Slug:** `KLAVIYO_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. Burst rate limit is 75/s, steady is 700/m. Requires `catalogs:write` scope.

### Spawn update items job

**Slug:** `KLAVIYO_SPAWN_UPDATE_ITEMS_JOB`

You can bulk update up to 100 catalog items with a 5MB payload limit. A max of 500 jobs can run concurrently. Rate limits are 75 requests/second and 700 requests/minute. Required scope: `catalogs:write`.

### Spawn update variants job

**Slug:** `KLAVIYO_SPAWN_UPDATE_VARIANTS_JOB`

Create a job to bulk update up to 100 catalog variants with a 5MB payload limit. A max of 500 jobs may run concurrently. Rate limits are 75/s burst and 700/m steady. Requires `catalogs:write` scope.

### Subscribe profiles

**Slug:** `KLAVIYO_SUBSCRIBE_PROFILES`

The API supports double opt-in for marketing, with 'historical_import' bypassing consent. It resets opt-outs for returning users. Caps at 1000 profiles, 75/s, and 700/min. Needs 'lists:write', 'profiles:write', 'subscriptions:write' permissions.

### Suppress profiles

**Slug:** `KLAVIYO_SUPPRESS_PROFILES`

Suppress profiles by email, segment, or list ID to stop email marketing, regardless of consent. View guides for details. Max 100 emails per request, with rate limits of 75/s and 700/m. Scopes: profiles:write, subscriptions:write.

### Unregister client push token

**Slug:** `KLAVIYO_UNREGISTER_CLIENT_PUSH_TOKEN`

This endpoint unsubscribes a push token, for use with Klaviyo's mobile SDKs and a public API key. Push notifications must be on. Rate limits are 3/s and 60/m.

### Unsubscribe profiles

**Slug:** `KLAVIYO_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. Use different method to remove without affecting subscriptions. More on consent and removal in the provided links.

### Unsuppress profiles

**Slug:** `KLAVIYO_UNSUPPRESS_PROFILES`

Remove 'USER_SUPPRESSED' blocks on profiles manually via email, segment, or list ID. Does not affect unsubscribes or other suppressions. Limits: 100 emails per request, 75/s burst, 700/m steady. Scope: 'subscriptions:write'.

### Update Campaign

**Slug:** `KLAVIYO_UPDATE_CAMPAIGN`

Update a campaign with the specified attributes. This action allows you to modify campaign settings including name, audiences, and send strategy. Only the fields you provide will be updated; others remain unchanged. Rate limits: 10/s burst, 150/m steady. Required scope: `campaigns:write`. Preconditions: - Valid API key with campaigns:write scope - Campaign ID must exist and be accessible - Campaign must be in a state that allows updates (usually draft status) - Send strategy options must match the selected method

### Update campaign message

**Slug:** `KLAVIYO_UPDATE_CAMPAIGN_MESSAGE`

Update a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`

### Update campaign send job

**Slug:** `KLAVIYO_UPDATE_CAMPAIGN_SEND_JOB`

Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`

### Update catalog category

**Slug:** `KLAVIYO_UPDATE_CATALOG_CATEGORY`

Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Update catalog category relationships items

**Slug:** `KLAVIYO_UPDATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMS`

Update item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Update catalog item

**Slug:** `KLAVIYO_UPDATE_CATALOG_ITEM`

Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Update catalog item relationships categories

**Slug:** `KLAVIYO_UPDATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIES`

Update catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Update catalog variant

**Slug:** `KLAVIYO_UPDATE_CATALOG_VARIANT`

Update a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`

### Update coupon

**Slug:** `KLAVIYO_UPDATE_COUPON`

Update an existing coupon's properties. Currently, only the coupon description can be updated. The coupon ID (external_id) cannot be changed after creation. *Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `coupons:write`

### Update coupon code

**Slug:** `KLAVIYO_UPDATE_COUPON_CODE`

Updates a coupon code specified by the given identifier synchronously. We allow updating the 'status' and 'expires_at' of coupon codes.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:write`

### Update flow status

**Slug:** `KLAVIYO_UPDATE_FLOW_STATUS`

Update the status of a flow with the given flow ID, and all actions in that flow. Flow statuses: - 'draft': Flow is disabled; no messages will be sent - 'manual': Messages require manual approval before sending - 'live': Messages are sent automatically when triggered Rate limits: Burst: 3/s, Steady: 60/m Required scope: flows:write

### Update image

**Slug:** `KLAVIYO_UPDATE_IMAGE`

Update the image with the given image ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:write`

### Update list

**Slug:** `KLAVIYO_UPDATE_LIST`

Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write`

### Update profile

**Slug:** `KLAVIYO_UPDATE_PROFILE`

Update profiles with the provided ID. Setting fields to `null` clears them; omitting fields retains existing data. Rate limits: 75/s burst, 700/m steady. Required scope: `profiles:write`.

### Update segment

**Slug:** `KLAVIYO_UPDATE_SEGMENT`

Update a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `segments:write`

### Update tag

**Slug:** `KLAVIYO_UPDATE_TAG`

Update the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another. **Important**: The `data__id` in the request body must match the `id` path parameter. Returns HTTP 204 No Content on success. *Rate limits*: Burst: `3/s` | Steady: `60/m` **Scopes:** `tags:read` `tags:write`

### Update tag group

**Slug:** `KLAVIYO_UPDATE_TAG_GROUP`

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.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`

### Update template

**Slug:** `KLAVIYO_UPDATE_TEMPLATE`

Update an existing email template by ID. Supports updating name, HTML content, and plaintext content. Note: This action only works with CODE editor type templates; drag & drop templates cannot be updated via API. Rate limits: Burst 10/s, Steady 150/m. Requires 'templates:write' scope.

### Update webhook

**Slug:** `KLAVIYO_UPDATE_WEBHOOK`

Update the webhook with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:write`

### Upload image from file

**Slug:** `KLAVIYO_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.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `100/m`<br>Daily: `100/d` **Scopes:** `images:write`

### Upload image from url

**Slug:** `KLAVIYO_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.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `100/m`<br>Daily: `100/d` **Scopes:** `images:write`
