- Category: marketing automation
- Auth: API_KEY, OAUTH2
- Composio-managed OAuth available? No
- Tools: 233
- Triggers: 0
- Slug:
KLAVIYO - Version: 20261101_00
Tools
Add Profile to List
Add Profile to List
Assign campaign message template
Assign campaign message template
KLAVIYO_ASSIGN_CAMPAIGN_MESSAGE_TEMPLATECreates a non-reusable version of the template and assigns it to the message.Rate limits:
Burst:
10/sSteady:
150/m Scopes: campaigns:writeInput Parameters
Output
Bulk create client events
Bulk create client events
KLAVIYO_BULK_CREATE_CLIENT_EVENTSSubmit client-side events to track profile activity using a public API key; the request can also update profile details and remove profile properties. Accepts up to 1,000 events per request, with rate limits of 10/s burst and 150/m steady.Input Parameters
exchange_id, this is an encrypted identifier used for identifying a profile by Klaviyo”s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.Output
Bulk create events
Bulk create events
KLAVIYO_BULK_CREATE_EVENTSBulk 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.Input Parameters
Output
Cancel Campaign Send
Cancel Campaign Send
KLAVIYO_CANCEL_CAMPAIGN_SENDCancel 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. This action modifies a campaign send job that is currently queued or sending. The cancel action is irreversible and sets the status to CANCELED. The revert action returns the campaign to DRAFT status, allowing further modifications. Rate limits: 10/s burst, 150/m steady. Required scope: campaigns:write. Preconditions: - Valid API key with campaigns:write scope - Campaign send job ID must exist and be accessible - Campaign must be in a state that allows cancellation (queued or sending)Input Parameters
Output
Create back in stock subscription
Create back in stock subscription
KLAVIYO_CREATE_BACK_IN_STOCK_SUBSCRIPTIONUse 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.Input Parameters
integrationType:::catalogId:::externalId. If the integration you are using is not set up for multi-catalog storage, the “catalogId” will be $default. For Shopify $shopify:::$default:::33001893429341Output
Create campaign
Create campaign
KLAVIYO_CREATE_CAMPAIGNCreates a campaign given a set of parameters, then returns it.Rate limits:
Burst:
10/sSteady:
150/m Scopes: campaigns:writeInput Parameters
Output
Create campaign clone
Create campaign clone
Create Campaign Recipient Estimation Job
Create Campaign Recipient Estimation Job
KLAVIYO_CREATE_CAMPAIGN_RECIPIENT_ESTIMATION_JOBStart 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 configuredInput Parameters
Output
Create campaign send job
Create campaign send job
KLAVIYO_CREATE_CAMPAIGN_SEND_JOBTrigger a campaign to send asynchronouslyRate limits:
Burst:
10/sSteady:
150/m Scopes: campaigns:writeInput Parameters
Output
Create catalog category
Create catalog category
Create catalog category relationships items
Create catalog category relationships items
KLAVIYO_CREATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSCreate a new item relationship for the given category ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: catalogs:writeInput Parameters
Output
Create catalog item
Create catalog item
KLAVIYO_CREATE_CATALOG_ITEMCreate a new catalog item.Rate limits:
Burst:
75/sSteady:
700/m Scopes: catalogs:writeInput Parameters
price on any child variants, using the Update Catalog Variant Endpoint.Output
Create catalog item relationships categories
Create catalog item relationships categories
KLAVIYO_CREATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESCreate a new catalog category relationship for the given item ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: catalogs:writeInput Parameters
Output
Create catalog variant
Create catalog variant
KLAVIYO_CREATE_CATALOG_VARIANTCreate a new variant for a related catalog item.Rate limits:
Burst:
75/sSteady:
700/m Scopes: catalogs:writeInput Parameters
price on any parent items using the Update Catalog Item Endpoint.1: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. 0 or 2: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.Output
Create client back in stock subscription
Create client back in stock subscription
KLAVIYO_CREATE_CLIENT_BACK_IN_STOCK_SUBSCRIPTIONUse 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.Input Parameters
integrationType:::catalogId:::externalId. If the integration you are using is not set up for multi-catalog storage, the “catalogId” will be $default. For Shopify $shopify:::$default:::33001893429341Output
Create Client Event V2
Create Client Event V2
KLAVIYO_CREATE_CLIENT_EVENT2Create a client-side event in Klaviyo to track user interactions. This action uses the company_id in the request body instead of as a query parameter. Use when tracking events from publicly-browseable, client-side environments with a public API key.Input Parameters
Output
Create client subscription
Create client subscription
KLAVIYO_CREATE_CLIENT_SUBSCRIPTIONEndpoint 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’.Input Parameters
exchange_id, this is an encrypted identifier used for identifying a profile by Klaviyo”s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.Output
Create coupon
Create coupon
Create coupon code
Create coupon code
KLAVIYO_CREATE_COUPON_CODECreate a coupon code for a given coupon. The action declares the coupon-codes:read scope.Input Parameters
Output
Create event
Create event
KLAVIYO_CREATE_EVENTCreate 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.Input Parameters
exchange_id, this is an encrypted identifier used for identifying a profile by Klaviyo”s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.Output
Create flow
Create flow
KLAVIYO_CREATE_FLOWCreate a draft flow from an encoded flow definition. For a minimal flow, use one list trigger, an empty actions array, and a null entry_action_id as shown in the definition example.Input Parameters
Output
Create form
Create form
Create list
Create list
Create or update client profile
Create or update client profile
KLAVIYO_CREATE_OR_UPDATE_CLIENT_PROFILEUpdate 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.Input Parameters
exchange_id, this is an encrypted identifier used for identifying a profile by Klaviyo”s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.Output
Create or update client push token
Create or update client push token
KLAVIYO_CREATE_OR_UPDATE_CLIENT_PUSH_TOKENThis 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.Input Parameters
exchange_id, this is an encrypted identifier used for identifying a profile by Klaviyo”s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.Output
Create or Update Profile
Create or Update Profile
KLAVIYO_CREATE_OR_UPDATE_PROFILECreate or update a Klaviyo profile using an email, phone number, external ID, or anonymous ID and supplied attributes. Null-valued fields are omitted from the request; the action requires profiles:write access.Input Parameters
Output
Create or update push token
Create or update push token
KLAVIYO_CREATE_OR_UPDATE_PUSH_TOKENCreate 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:writeInput Parameters
exchange_id, this is an encrypted identifier used for identifying a profile by Klaviyo”s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.Output
Create profile
Create profile
KLAVIYO_CREATE_PROFILECreate a new profile.Rate limits:
Burst:
75/sSteady:
700/m Scopes: profiles:writeInput Parameters
Output
Create segment
Create segment
Create tag
Create tag
KLAVIYO_CREATE_TAGCreate a tag in an account, optionally specifying its tag group. The account has a maximum of 500 tags; rate limits are 3/s burst and 60/min steady.Input Parameters
Output
Create tag group
Create tag group
Create Tag Relationships
Create Tag Relationships
KLAVIYO_CREATE_TAG_RELATIONSHIPSAssociate a tag with other resources (flows, lists, segments, or campaigns) in Klaviyo. Use when you need to link a tag to one or more resources for organizational purposes. Note: A resource can have up to 100 tags associated with it. Rate limits: 3/s burst, 60/m steady. Required scopes vary by resource type: tags:write plus the appropriate write scope (flows:write, lists:write, segments:write, or campaigns:write).Input Parameters
Output
Create template
Create template
Create template clone
Create template clone
Create template render
Create template render
Create webhook
Create webhook
KLAVIYO_CREATE_WEBHOOKCreate a webhook to receive real-time notifications for specified Klaviyo events. The action declares webhooks:read and webhooks:write scopes; event-based topics may also require events:read, rate limits are burst 1/s and steady 15/m, and each account can have a maximum of 10 webhooks.Input Parameters
Output
Delete campaign
Delete campaign
Delete catalog category
Delete catalog category
KLAVIYO_DELETE_CATALOG_CATEGORYDelete a catalog category using the given category ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: catalogs:writeInput Parameters
{integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.Output
Delete catalog category relationships items
Delete catalog category relationships items
KLAVIYO_DELETE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSDelete item relationships for the given category ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: catalogs:writeInput Parameters
Output
Delete catalog item
Delete catalog item
KLAVIYO_DELETE_CATALOG_ITEMDelete a catalog item with the given item ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: catalogs:writeInput Parameters
{integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.Output
Delete catalog item relationships categories
Delete catalog item relationships categories
Delete catalog variant
Delete catalog variant
KLAVIYO_DELETE_CATALOG_VARIANTDelete a catalog item variant with the given variant ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: catalogs:writeInput Parameters
{integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.Output
Delete coupon
Delete coupon
Delete coupon code
Delete coupon code
KLAVIYO_DELETE_COUPON_CODEDeletes a coupon code specified by the given identifier synchronously. If a profile has been assigned to the coupon code, an exception will be raisedRate limits:
Burst:
350/sSteady:
3500/m Scopes: coupon-codes:writeInput Parameters
Output
Delete flow
Delete flow
Delete form
Delete form
Delete list
Delete list
Delete segment
Delete segment
Delete tag
Delete tag
Delete tag group
Delete tag group
Delete Tag Relationships
Delete Tag Relationships
KLAVIYO_DELETE_TAG_RELATIONSHIPSRemove a tag’s association with other resources like flows, campaigns, lists, or segments. Use when you need to untag resources without deleting the tag itself.Input Parameters
Output
Delete template
Delete template
KLAVIYO_DELETE_TEMPLATEPermanently 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.Input Parameters
Output
Delete webhook
Delete webhook
KLAVIYO_DELETE_WEBHOOKPermanently 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).Input Parameters
Output
Get account
Get account
KLAVIYO_GET_ACCOUNTRetrieve a single account object by its account ID. You can only request the account by which the private API key was generated.Rate limits:
Burst:
1/sSteady:
15/m Scopes: accounts:readInput Parameters
Output
Get accounts
Get accounts
KLAVIYO_GET_ACCOUNTSUse 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.Input Parameters
Output
Get Bulk Create Coupon Codes Job
Get Bulk Create Coupon Codes Job
KLAVIYO_GET_BULK_CREATE_COUPON_CODES_JOBTool to get a coupon code bulk create job with the given job ID. Use when you need to check the status of a previously initiated bulk coupon code creation job. Rate limits: 75/s burst, 700/m steady. Required scope: coupon-codes:read.Input Parameters
Output
Get Bulk Delete Catalog Items Job
Get Bulk Delete Catalog Items Job
KLAVIYO_GET_BULK_DELETE_CATALOG_ITEMS_JOBGet 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. Rate limits: 350/s burst, 3500/m steady. Required scope: catalogs:read. Preconditions: - Valid API key with catalogs:read scope - Job ID must exist and be accessibleInput Parameters
Output
Get bulk profile import job
Get bulk profile import job
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOBGet a bulk profile import job with the given job ID.Rate limits:
Burst:
10/sSteady:
150/m Scopes: lists:read profiles:readInput Parameters
Output
Get bulk profile import job errors
Get bulk profile import job errors
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_ERRORSGet import errors for the bulk profile import job with the given ID.Rate limits:
Burst:
10/sSteady:
150/m Scopes: profiles:readInput Parameters
Output
Get bulk profile import job lists
Get bulk profile import job lists
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_LISTSGet list for the bulk profile import job with the given ID.Rate limits:
Burst:
10/sSteady:
150/m Scopes: lists:readInput Parameters
Output
Get bulk profile import job profiles
Get bulk profile import job profiles
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_PROFILESGet profiles for the bulk profile import job with the given ID.Rate limits:
Burst:
10/sSteady:
150/m Scopes: profiles:readInput Parameters
Output
Get bulk profile import job relationships lists
Get bulk profile import job relationships lists
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_LISTSGet list relationship for the bulk profile import job with the given ID.Rate limits:
Burst:
10/sSteady:
150/m Scopes: lists:readInput Parameters
Output
Get bulk profile import job relationships profiles
Get bulk profile import job relationships profiles
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_PROFILESGet profile relationships for the bulk profile import job with the given ID.Rate limits:
Burst:
10/sSteady:
150/m Scopes: profiles:readInput Parameters
Output
Get bulk profile import jobs
Get bulk profile import jobs
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOBSGet bulk profile import jobs, with up to 100 jobs per request. Rate limits: 10/s burst and 150/m steady; the tool declares lists:write and profiles:write scopes.Input Parameters
Allowed field(s)/operator(s):
status: any, equalsOutput
Get bulk update catalog items job
Get bulk update catalog items job
KLAVIYO_GET_BULK_UPDATE_CATALOG_ITEMS_JOBGet 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.Input Parameters
Output
Get Bulk Update Categories Job
Get Bulk Update Categories Job
KLAVIYO_GET_BULK_UPDATE_CATEGORIES_JOBRetrieve a catalog category bulk update job by its ID from Klaviyo. This action fetches the status and details of a bulk update job for catalog categories, including progress metrics (total, completed, failed counts) and optionally the related category resources. Use this to track the progress of bulk category update operations. Rate limits: 350/s burst, 3500/m steady. Required scope: catalogs:read. Preconditions: - Valid API key with catalogs:read scope - Job ID must exist and be accessibleInput Parameters
Output
Get Bulk Update Variants Job
Get Bulk Update Variants Job
KLAVIYO_GET_BULK_UPDATE_VARIANTS_JOBTool to retrieve a catalog variant bulk update job by its ID. Use when you need to check the status, progress, or results of a bulk update operation on catalog variants.Input Parameters
Output
Get Campaign
Get Campaign
KLAVIYO_GET_CAMPAIGNRetrieve 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 accessibleInput Parameters
Output
Get campaign campaign messages
Get campaign campaign messages
KLAVIYO_GET_CAMPAIGN_CAMPAIGN_MESSAGESRetrieve messages belonging to a campaign; requires campaigns:read. The response can contain pagination links.Input Parameters
Output
Get campaign message
Get campaign message
KLAVIYO_GET_CAMPAIGN_MESSAGEReturns a specific message based on a required id.Rate limits:
Burst:
10/sSteady:
150/m Scopes: campaigns:readInput Parameters
Output
Get campaign message campaign
Get campaign message campaign
KLAVIYO_GET_CAMPAIGN_MESSAGE_CAMPAIGNReturn the related campaignRate limits:
Burst:
10/sSteady:
150/m Scopes: campaigns:readInput Parameters
Output
Get campaign message relationships campaign
Get campaign message relationships campaign
KLAVIYO_GET_CAMPAIGN_MESSAGE_RELATIONSHIPS_CAMPAIGNReturns the ID of the related campaignRate limits:
Burst:
10/sSteady:
150/m Scopes: campaigns:readInput Parameters
Output
Get campaign message relationships template
Get campaign message relationships template
Get campaign message template
Get campaign message template
KLAVIYO_GET_CAMPAIGN_MESSAGE_TEMPLATEReturn the related templateRate limits:
Burst:
10/sSteady:
150/m Scopes: campaigns:read templates:readInput Parameters
Output
Get campaign recipient estimation
Get campaign recipient estimation
KLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATIONGet 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.Input Parameters
Output
Get campaign recipient estimation job
Get campaign recipient estimation job
KLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATION_JOBRetrieve the status of a recipient estimation job triggered with the Create Campaign Recipient Estimation Job endpoint.Rate limits:
Burst:
10/sSteady:
150/m Scopes: campaigns:readInput Parameters
Output
Get campaign relationships campaign messages
Get campaign relationships campaign messages
Get Campaigns
Get Campaigns
KLAVIYO_GET_CAMPAIGNSRetrieve a page of Klaviyo campaigns filtered by channel, with optional additional filtering and sorting. The channel defaults to email, archived campaigns are excluded unless requested, and the required scope is campaigns:read.Input Parameters
links.next until it returns null to retrieve all results.Output
Get campaign send job
Get campaign send job
KLAVIYO_GET_CAMPAIGN_SEND_JOBGet a campaign send jobRate limits:
Burst:
10/sSteady:
150/m Scopes: campaigns:readInput Parameters
Output
Get catalog categories
Get catalog categories
KLAVIYO_GET_CATALOG_CATEGORIESRetrieve 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.Input Parameters
Allowed field(s)/operator(s):
ids: anyitem.id: equalsname: containsOutput
Get catalog category
Get catalog category
KLAVIYO_GET_CATALOG_CATEGORYGet a catalog category with the given category ID.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: catalogs:readInput Parameters
{integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.Output
Get catalog category items
Get catalog category items
KLAVIYO_GET_CATALOG_CATEGORY_ITEMSRetrieve 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.Input Parameters
Allowed field(s)/operator(s):
ids: anycategory.id: equalstitle: containspublished: equalsOutput
Get catalog category relationships items
Get catalog category relationships items
KLAVIYO_GET_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSRetrieve catalog item identifiers associated with a category, up to 100 per request. Rate limits: 350/s burst and 3500/m steady; the tool declares the catalogs:write scope.Input Parameters
Output
Get catalog item
Get catalog item
KLAVIYO_GET_CATALOG_ITEMGet a specific catalog item with the given item ID.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: catalogs:readInput Parameters
{integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.Output
Get catalog item categories
Get catalog item categories
KLAVIYO_GET_CATALOG_ITEM_CATEGORIESRetrieve 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.Input Parameters
Allowed field(s)/operator(s):
ids: anyitem.id: equalsname: containsOutput
Get catalog item relationships categories
Get catalog item relationships categories
KLAVIYO_GET_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESRetrieve catalog category identifiers associated with an item, up to 100 per request. Rate limits: 350/s burst and 3500/m steady; scope: catalogs:read.Input Parameters
Output
Get catalog items
Get catalog items
KLAVIYO_GET_CATALOG_ITEMSRetrieve 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.Input Parameters
Allowed field(s)/operator(s):
ids: anycategory.id: equalstitle: containspublished: equalsOutput
Get catalog item variants
Get catalog item variants
KLAVIYO_GET_CATALOG_ITEM_VARIANTSRetrieve 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.Input Parameters
Allowed field(s)/operator(s):
ids: anyitem.id: equalssku: equalstitle: containspublished: equalsOutput
Get catalog variant
Get catalog variant
KLAVIYO_GET_CATALOG_VARIANTGet a catalog item variant with the given variant ID.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: catalogs:readInput Parameters
{integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.Output
Get catalog variants
Get catalog variants
KLAVIYO_GET_CATALOG_VARIANTSRetrieve 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.Input Parameters
Allowed field(s)/operator(s):
ids: anyitem.id: equalssku: equalstitle: containspublished: equalsOutput
Get coupon
Get coupon
KLAVIYO_GET_COUPONGet a specific coupon by coupon ID. The action declares the coupon-codes:read scope.Input Parameters
Output
Get coupon code
Get coupon code
KLAVIYO_GET_COUPON_CODEReturns a Coupon Code specified by the given identifier.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: coupon-codes:readInput Parameters
Output
Get coupon code bulk create job
Get coupon code bulk create job
KLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOBGet a coupon code bulk create job with the given job ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: coupon-codes:readInput Parameters
Output
Get coupon code bulk create jobs
Get coupon code bulk create jobs
KLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOBSGet coupon code bulk create jobs, with cursor pagination and optional status filtering. The action declares the coupon-codes:write scope.Input Parameters
Allowed field(s)/operator(s):
status: equalsOutput
Get coupon code relationships coupon
Get coupon code relationships coupon
KLAVIYO_GET_COUPON_CODE_RELATIONSHIPS_COUPONGets a list of coupon code relationships associated with the given coupon idRate limits:
Burst:
75/sSteady:
700/m Scopes: coupon-codes:readInput Parameters
Output
Get coupon codes
Get coupon codes
KLAVIYO_GET_COUPON_CODESObtains coupon codes using necessary coupon or profile filters. Rate limits: 350/s, 3500/m. Requires ‘coupon-codes:read’ scope.Input Parameters
Allowed field(s)/operator(s):
expires_at: greater-or-equal, greater-than, less-or-equal, less-thanstatus: equalscoupon.id: any, equalsprofile.id: any, equalsOutput
Get coupon codes for coupon
Get coupon codes for coupon
KLAVIYO_GET_COUPON_CODES_FOR_COUPONGets a list of coupon codes associated with the given coupon idRate limits:
Burst:
75/sSteady:
700/m Scopes: coupon-codes:readInput Parameters
Allowed field(s)/operator(s):
expires_at: greater-or-equal, greater-than, less-or-equal, less-thanstatus: equalscoupon.id: any, equalsprofile.id: any, equalsOutput
Get coupon for coupon code
Get coupon for coupon code
KLAVIYO_GET_COUPON_FOR_COUPON_CODEGet the coupon associated with a given coupon code ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: coupons:readInput Parameters
Output
Get Coupon ID for Coupon Code
Get Coupon ID for Coupon Code
Get Coupon Relationships Coupon Codes
Get Coupon Relationships Coupon Codes
KLAVIYO_GET_COUPON_RELATIONSHIPS_COUPON_CODESRetrieve coupon code relationship identifiers for a given coupon; pagination links may be returned, but subsequent pages cannot be requested through this tool. The declared scope is coupons:read, with rate limits of 75/s burst and 700/m steady.Input Parameters
Output
Get coupons
Get coupons
KLAVIYO_GET_COUPONSGet all coupons in an account. To learn more, see our Coupons API guide.Rate limits:
Burst:
75/sSteady:
700/m Scopes: coupons:readInput Parameters
Output
Get create categories job
Get create categories job
KLAVIYO_GET_CREATE_CATEGORIES_JOBGet a catalog category bulk create job with the given job ID. An include parameter can be provided to get the following related resource data: categories.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: catalogs:readInput Parameters
Output
Get create categories jobs
Get create categories jobs
KLAVIYO_GET_CREATE_CATEGORIES_JOBSGet catalog category bulk create jobs, with up to 100 jobs per request. The tool declares catalogs:write, with rate limits of 350/s burst and 3500/m steady.Input Parameters
Allowed field(s)/operator(s):
status: equalsOutput
Get create items job
Get create items job
KLAVIYO_GET_CREATE_ITEMS_JOBGet a catalog item bulk create job with the given job ID. An include parameter can be provided to get the following related resource data: items.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: catalogs:readInput Parameters
Output
Get create items jobs
Get create items jobs
KLAVIYO_GET_CREATE_ITEMS_JOBSGet catalog item bulk create jobs, with up to 100 jobs per request. The tool declares catalogs:write, with rate limits of 350/s burst and 3500/m steady.Input Parameters
Allowed field(s)/operator(s):
status: equalsOutput
Get create variants job
Get create variants job
KLAVIYO_GET_CREATE_VARIANTS_JOBGet a catalog variant bulk create job by its job ID to check its status and processing results. Related variants can be included, and sparse fieldsets can be requested. Requires the catalogs:read scope; rate limits are 350 requests per second burst and 3,500 per minute steady.Input Parameters
Output
Get create variants jobs
Get create variants jobs
KLAVIYO_GET_CREATE_VARIANTS_JOBSGet catalog variant bulk create jobs, with up to 100 jobs per request. The tool declares catalogs:write, with rate limits of 350/s burst and 3500/m steady.Input Parameters
Allowed field(s)/operator(s):
status: equalsOutput
Get delete categories job
Get delete categories job
KLAVIYO_GET_DELETE_CATEGORIES_JOBGet a catalog category bulk delete job with the given job ID.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: catalogs:readInput Parameters
Output
Get delete categories jobs
Get delete categories jobs
KLAVIYO_GET_DELETE_CATEGORIES_JOBSGet catalog category bulk delete jobs, with up to 100 jobs per request. The tool declares catalogs:write, with rate limits of 350/s burst and 3500/m steady.Input Parameters
Allowed field(s)/operator(s):
status: equalsOutput
Get delete items jobs
Get delete items jobs
KLAVIYO_GET_DELETE_ITEMS_JOBSGet catalog item bulk delete jobs, with up to 100 jobs per request. The tool declares catalogs:write, with rate limits of 350/s burst and 3500/m steady.Input Parameters
Allowed field(s)/operator(s):
status: equalsOutput
Get delete variants job
Get delete variants job
KLAVIYO_GET_DELETE_VARIANTS_JOBGet a catalog variant bulk delete job with the given job ID.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: catalogs:readInput Parameters
Output
Get delete variants jobs
Get delete variants jobs
KLAVIYO_GET_DELETE_VARIANTS_JOBSGet catalog variant bulk delete jobs, with optional status filtering and cursor pagination, returning a maximum of 100 jobs per request. The tool is configured with the catalogs:write scope.Input Parameters
Allowed field(s)/operator(s):
status: equalsOutput
Get event
Get event
KLAVIYO_GET_EVENTGet an event with the given event ID.Rate limits:
Burst:
10/sSteady:
150/m Scopes: events:readInput Parameters
Output
Get event metric
Get event metric
KLAVIYO_GET_EVENT_METRICGet the metric for an event with the given event ID.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: events:read metrics:readInput Parameters
Output
Get event profile
Get event profile
KLAVIYO_GET_EVENT_PROFILEGet the profile associated with an event with the given event ID.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: events:read profiles:readInput Parameters
Output
Get Event Relationships
Get Event Relationships
KLAVIYO_GET_EVENT_RELATIONSHIPSGet metrics or profile relationships for a specific event. Use when you need to retrieve the metric or profile associated with an event. Rate limits: 350/s burst, 3500/m steady. Required scopes: Events Read, Metrics Read, Profiles Read.Input Parameters
Output
Get events
Get events
KLAVIYO_GET_EVENTSGet all events in an account Requests can be sorted by the following fields: datetime, timestamp Returns a maximum of 200 events per page.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: events:readInput Parameters
metric_id: equals - The metric_id must be a 6-character alphanumeric ID (e.g., ‘Vatr8j’), NOT a metric name like ‘Opened Email’. Use the Get Metrics endpoint (KLAVIYO_GET_METRICS) to retrieve valid metric IDs for your account. profile_id: equals - The profile_id must be a valid Klaviyo profile ID. profile: has - Check if profile exists. datetime: greater-or-equal, greater-than, less-or-equal, less-than - Use ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’). timestamp: greater-or-equal, greater-than, less-or-equal, less-than - Unix timestamp. Example: equals(metric_id,“Vatr8j”),greater-than(datetime,2024-01-01T00:00:00Z). For more information: https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filteringOutput
Get flow
Get flow
KLAVIYO_GET_FLOWGet a flow with the given flow ID.Rate limits:
Burst:
3/sSteady:
60/m Scopes: flows:readInput Parameters
Output
Get flow action
Get flow action
KLAVIYO_GET_FLOW_ACTIONGet a flow action from a flow with the given flow action ID.Rate limits:
Burst:
3/sSteady:
60/m Scopes: flows:readInput Parameters
Output
Get flow action for message
Get flow action for message
KLAVIYO_GET_FLOW_ACTION_FOR_MESSAGEGet the flow action for a flow message with the given message ID.Rate limits:
Burst:
3/sSteady:
60/m Scopes: flows:readInput Parameters
Output
Get flow action messages
Get flow action messages
KLAVIYO_GET_FLOW_ACTION_MESSAGESRetrieve flow messages for an action ID, with filtering, page size, and ascending or descending sorting. Rate limits are 3/s burst and 60/m steady; scope required is flows:read.Input Parameters
Allowed field(s)/operator(s):
id: anyname: contains, ends-with, equals, starts-withcreated: equals, greater-or-equal, greater-than, less-or-equal, less-thanupdated: equals, greater-or-equal, greater-than, less-or-equal, less-thanOutput
Get Parent Flow for Flow Action
Get Parent Flow for Flow Action
KLAVIYO_GET_FLOW_ACTION_RELATIONSHIPS_FLOWGet 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:readInput Parameters
Output
Get flow action relationships messages
Get flow action relationships messages
KLAVIYO_GET_FLOW_ACTION_RELATIONSHIPS_MESSAGESRetrieves 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.Input Parameters
name: contains, ends-with, equals, starts-with; created: equals, greater-or-equal, greater-than, less-or-equal, less-than; updated: equals, greater-or-equal, greater-than, less-or-equal, less-than. Example: equals(name,‘Welcome Email’).Output
Get flow flow actions
Get flow flow actions
KLAVIYO_GET_FLOW_FLOW_ACTIONSGet 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.Rate limits:
Burst:
3/sSteady:
60/m Scopes: flows:readInput Parameters
Allowed field(s)/operator(s):
id: anyaction_type: any, equals (valid values: BOOLEAN_BRANCH, SEND_EMAIL, UPDATE_CUSTOMER, <PERSON>, TIME_DELAY, BACK_IN_STOCK_DELAY, COUNTDOWN_DELAY, SEND_SMS, SEND_NOTIFICATION_MESSAGE, WEBHOOK, AB_TEST)status: equalscreated: equals, greater-or-equal, greater-than, less-or-equal, less-thanupdated: equals, greater-or-equal, greater-than, less-or-equal, less-thanOutput
Get flow for flow action
Get flow for flow action
KLAVIYO_GET_FLOW_FOR_FLOW_ACTIONGet the flow associated with the given action ID.Rate limits:
Burst:
3/sSteady:
60/m Scopes: flows:readInput Parameters
Output
Get flow message
Get flow message
KLAVIYO_GET_FLOW_MESSAGEGet the flow message of a flow with the given message ID.Rate limits:
Burst:
3/sSteady:
60/m Scopes: flows:readInput Parameters
Output
Get flow message relationships action
Get flow message relationships action
KLAVIYO_GET_FLOW_MESSAGE_RELATIONSHIPS_ACTIONGet 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:readInput Parameters
Output
Get flow message relationships template
Get flow message relationships template
KLAVIYO_GET_FLOW_MESSAGE_RELATIONSHIPS_TEMPLATEReturns the ID of the related templateRate limits:
Burst:
3/sSteady:
60/m Scopes: templates:readInput Parameters
Output
Get flow message template
Get flow message template
KLAVIYO_GET_FLOW_MESSAGE_TEMPLATEReturn the related templateRate limits:
Burst:
3/sSteady:
60/m Scopes: templates:readInput Parameters
Output
Get flow relationships flow actions
Get flow relationships flow actions
KLAVIYO_GET_FLOW_RELATIONSHIPS_FLOW_ACTIONSRetrieve flow action relationship identifiers for a flow ID, with filtering, sorting, and a configurable page size. Requires flows:read; rate limits are 3/s burst and 60/m steady.Input Parameters
action_type: equals - Valid values: BOOLEAN_BRANCH, SEND_EMAIL, UPDATE_CUSTOMER, <PERSON>, TIME_DELAY, BACK_IN_STOCK_DELAY, COUNTDOWN_DELAY, SEND_SMS, SEND_NOTIFICATION_MESSAGE, WEBHOOK, AB_TEST (e.g., ‘equals(action_type,“SEND_EMAIL”)’); status: equals (e.g., ‘equals(status,“live”)’); created: equals, greater-or-equal, greater-than, less-or-equal, less-than; updated: equals, greater-or-equal, greater-than, less-or-equal, less-than. See https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering for more details.Output
Get flows
Get flows
KLAVIYO_GET_FLOWSGet all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.Rate limits:
Burst:
3/sSteady:
60/m Scopes: flows:readInput Parameters
operator(field,"value"). String values MUST be quoted. Examples: equals(status,"live"), contains(name,"welcome"), any(id,["ID1","ID2"]). Allowed field(s)/operator(s): id: any; name: contains, ends-with, equals, starts-with; status: equals; archived: equals; created: equals, greater-or-equal, greater-than, less-or-equal, less-than; updated: equals, greater-or-equal, greater-than, less-or-equal, less-than; trigger_type: equals. For more information visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filteringOutput
Get form
Get form
KLAVIYO_GET_FORMGet the form with the given ID.Rate limits:
Burst:
3/sSteady:
60/m Scopes: forms:readInput Parameters
Output
Get form for form version
Get form for form version
KLAVIYO_GET_FORM_FOR_FORM_VERSIONGet the form associated with the given form version.Rate limits:
Burst:
3/sSteady:
60/m Scopes: forms:readInput Parameters
Output
Get form id for form version
Get form id for form version
Get forms
Get forms
KLAVIYO_GET_FORMSGet all forms in an account.Rate limits:
Burst:
3/sSteady:
60/m Scopes: forms:readInput Parameters
Allowed field(s)/operator(s):
id: any, equalsname: any, contains, equalsab_test: equalsupdated_at: greater-or-equal, greater-than, less-or-equal, less-thancreated_at: greater-or-equal, greater-than, less-or-equal, less-thanstatus: equalsOutput
Get form version
Get form version
KLAVIYO_GET_FORM_VERSIONRetrieve 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:readInput Parameters
Output
Get image
Get image
KLAVIYO_GET_IMAGEGet the image with the given image ID.Rate limits:
Burst:
10/sSteady:
150/m Scopes: images:readInput Parameters
Output
Get images
Get images
KLAVIYO_GET_IMAGESGet all images in an account.Rate limits:
Burst:
10/sSteady:
150/m Scopes: images:readInput Parameters
Allowed field(s)/operator(s):
id: any, equalsupdated_at: greater-or-equal, greater-than, less-or-equal, less-thanformat: any, equalsname: any, contains, ends-with, equals, starts-withsize: greater-or-equal, greater-than, less-or-equal, less-thanhidden: any, equalsOutput
Get list
Get list
KLAVIYO_GET_LISTRetrieve a Klaviyo list by ID. Requires lists:read scope; rate limits are 75/s and 700/m, or 1/s and 15/m when requesting profile count.Input Parameters
Output
Get list profiles
Get list profiles
KLAVIYO_GET_LIST_PROFILESRetrieve 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.Input Parameters
Allowed field(s)/operator(s):
email: any, equalsphone_number: any, equalspush_token: any, equals_kx: equalsjoined_group_at: greater-or-equal, greater-than, less-or-equal, less-thanOutput
Get List Relationships
Get List Relationships
KLAVIYO_GET_LIST_RELATIONSHIPSGet profile membership relationships for a Klaviyo list. Returns references (IDs) to profiles that are members of the specified list. Use when you need to retrieve which profiles belong to a list without fetching full profile data.Input Parameters
Output
Get Lists
Get Lists
Get metric
Get metric
KLAVIYO_GET_METRICGet a metric with the given metric ID.Rate limits:
Burst:
10/sSteady:
150/m Scopes: metrics:readInput Parameters
Output
Get metrics
Get metrics
KLAVIYO_GET_METRICSGet all metrics in an account. Requests can be filtered by the following fields: integration name, integration category Returns a maximum of 200 results per page.Rate limits:
Burst:
10/sSteady:
150/m Scopes: metrics:readInput Parameters
integration.name with equals, integration.category with equals. Example: equals(integration.name,‘Klaviyo’) or equals(integration.category,‘Internal’). For more information visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filteringOutput
Get profile
Get profile
KLAVIYO_GET_PROFILEGet the profile with the given profile ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: profiles:readInput Parameters
Output
Get profile lists
Get profile lists
KLAVIYO_GET_PROFILE_LISTSGet list memberships for a profile with the given profile ID.Rate limits:
Burst:
3/sSteady:
60/m Scopes: lists:read profiles:readInput Parameters
Output
Get Profile Relationships
Get Profile Relationships
KLAVIYO_GET_PROFILE_RELATIONSHIPSTool to get list membership or segment membership relationships for a profile with the given profile ID. Use when you need to determine which lists or segments a specific profile belongs to.Input Parameters
Output
Get Profiles
Get Profiles
KLAVIYO_GET_PROFILESRetrieve 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 100Input Parameters
Output
Get profile segments
Get profile segments
KLAVIYO_GET_PROFILE_SEGMENTSGet segment memberships for a profile with the given profile ID.Rate limits:
Burst:
3/sSteady:
60/m Scopes: profiles:read segments:readInput Parameters
Output
Get reviews
Get reviews
Get segment
Get segment
KLAVIYO_GET_SEGMENTFetch 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.Input Parameters
Output
Get segment profiles
Get segment profiles
KLAVIYO_GET_SEGMENT_PROFILESRetrieve 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.Input Parameters
Allowed field(s)/operator(s):
email: any, equalsphone_number: any, equalspush_token: any, equals_kx: equalsjoined_group_at: greater-or-equal, greater-than, less-or-equal, less-thanOutput
Get Segment Relationships
Get Segment Relationships
KLAVIYO_GET_SEGMENT_RELATIONSHIPSGet a page of profile membership or tag relationships for a segment, with pagination links when returned. The action declares profiles:read, segments:read, and tags:read scopes.Input Parameters
Output
Get segments
Get segments
KLAVIYO_GET_SEGMENTSFetch 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.Input Parameters
Allowed field(s)/operator(s):
name: any, equalsid: any, equalscreated: greater-thanupdated: greater-thanis_active: any, equalsis_starred: equalsOutput
Get tag
Get tag
KLAVIYO_GET_TAGRetrieve the tag with the given tag ID.Rate limits:
Burst:
3/sSteady:
60/m Scopes: tags:readInput Parameters
Output
Get tag group
Get tag group
KLAVIYO_GET_TAG_GROUPRetrieve the tag group with the given tag group ID.Rate limits:
Burst:
3/sSteady:
60/m Scopes: tags:readInput Parameters
Output
Get tag groups
Get tag groups
KLAVIYO_GET_TAG_GROUPSRetrieve 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.Input Parameters
Allowed field(s)/operator(s):
name: contains, ends-with, equals, starts-withexclusive: equalsdefault: equalsOutput
Get Tag Relationships
Get Tag Relationships
KLAVIYO_GET_TAG_RELATIONSHIPSTool 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. The response format varies based on the related_resource type: - For collections (campaigns, flows, lists, segments): returns an array of resource identifiers - For tag-group: returns a single resource identifier object Rate limits: 3/s burst, 60/m steady. Required scopes: tags:read and scope for the related resource type.Input Parameters
Output
Get tag tag group
Get tag tag group
KLAVIYO_GET_TAG_TAG_GROUPReturns the tag group resource for a given tag ID.Rate limits:
Burst:
3/sSteady:
60/m Scopes: tags:readInput Parameters
Output
Get template
Get template
KLAVIYO_GET_TEMPLATEGet a template by ID, optionally requesting specific fields; the action raises an error if a requested field is absent from the response. Rate limits: 10/s burst, 150/m steady; requires templates:read.Input Parameters
Output
Get templates
Get templates
KLAVIYO_GET_TEMPLATESRetrieve 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.Input Parameters
Allowed field(s)/operator(s):
id: any, equalsname: any, equalscreated: equals, greater-or-equal, greater-than, less-or-equal, less-thanupdated: equals, greater-or-equal, greater-than, less-or-equal, less-thanOutput
Get translations
Get translations
Get update categories jobs
Get update categories jobs
KLAVIYO_GET_UPDATE_CATEGORIES_JOBSGet all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: catalogs:readInput Parameters
Output
Get update items job
Get update items job
KLAVIYO_GET_UPDATE_ITEMS_JOBGet a catalog item bulk update job with the given job ID. An include parameter can be provided to get the following related resource data: items.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: catalogs:readInput Parameters
Output
Get update items jobs
Get update items jobs
KLAVIYO_GET_UPDATE_ITEMS_JOBSGet catalog item bulk update jobs, with status filtering and cursor pagination, returning a maximum of 100 jobs per request. Rate limits: 350/s burst and 3500/m steady; the tool declares the catalogs:write scope.Input Parameters
Allowed field(s)/operator(s):
status: equalsOutput
Get update variants jobs
Get update variants jobs
KLAVIYO_GET_UPDATE_VARIANTS_JOBSGet all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: catalogs:readInput Parameters
Output
Get Variant IDs for Catalog Item
Get Variant IDs for Catalog Item
KLAVIYO_GET_VARIANT_IDS_FOR_CATALOG_ITEMTool to get all variant IDs related to a given catalog item ID. Returns a maximum of 100 variants per request. Use when you need to retrieve variant IDs without fetching full variant data. Supports filtering and sorting by creation date.Input Parameters
Output
Get version ids for form
Get version ids for form
Get versions for form
Get versions for form
KLAVIYO_GET_VERSIONS_FOR_FORMGet the form versions for the given form.Rate limits:
Burst:
3/sSteady:
60/m Scopes: forms:readInput Parameters
Allowed field(s)/operator(s):
form_type: any, equalsstatus: equalsupdated_at: greater-or-equal, greater-than, less-or-equal, less-thancreated_at: greater-or-equal, greater-than, less-or-equal, less-thanOutput
Get webhook
Get webhook
KLAVIYO_GET_WEBHOOKGet the webhook with the given ID.Rate limits:
Burst:
1/sSteady:
15/m Scopes: webhooks:readInput Parameters
Output
Get webhooks
Get webhooks
KLAVIYO_GET_WEBHOOKSGet webhooks in an account; the response can include pagination links. Scope: webhooks:read; rate limits: burst 1/s, steady 15/m.Input Parameters
Output
Get webhook topic
Get webhook topic
KLAVIYO_GET_WEBHOOK_TOPICRetrieve 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:readInput Parameters
Output
Get webhook topics
Get webhook topics
Merge profiles
Merge profiles
KLAVIYO_MERGE_PROFILESMerge 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.Input Parameters
Output
Query campaign values
Query campaign values
KLAVIYO_QUERY_CAMPAIGN_VALUESReturns the requested campaign analytics values dataRate limits:
Burst:
1/sSteady:
2/mDaily:
225/d Scopes: campaigns:readInput Parameters
Output
Query flow series
Query flow series
KLAVIYO_QUERY_FLOW_SERIESReturns 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:readInput Parameters
Output
Query flow values
Query flow values
KLAVIYO_QUERY_FLOW_VALUESReturns the requested flow analytics values dataRate limits:
Burst:
1/sSteady:
2/mDaily:
225/d Scopes: flows:readInput Parameters
Output
Query form series
Query form series
KLAVIYO_QUERY_FORM_SERIESReturn Klaviyo form performance metrics broken into time intervals.Input Parameters
Output
Query form values
Query form values
KLAVIYO_QUERY_FORM_VALUESReturn aggregate Klaviyo form performance statistics for a timeframe.Input Parameters
Output
Query metric aggregates
Query metric aggregates
KLAVIYO_QUERY_METRIC_AGGREGATESQuery aggregated metric measurements with grouping, sorting, and time-based filters. Rate limits: 3 requests per second and 60 per minute; scope: metrics:read.Input Parameters
"America/New_York". This field is validated against a list of common timezones from the IANA Time Zone Database. While most are supported, a few notable exceptions are Factory, Europe/Kyiv and Pacific/Kanton. This field is case-sensitive.Output
Remove Profile from List
Remove Profile from List
Request profile deletion
Request profile deletion
KLAVIYO_REQUEST_PROFILE_DELETIONTo 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.Input Parameters
Output
Spawn bulk profile import job
Spawn bulk profile import job
KLAVIYO_SPAWN_BULK_PROFILE_IMPORT_JOBInitiate 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.Input Parameters
Output
Spawn coupon code bulk create job
Spawn coupon code bulk create job
KLAVIYO_SPAWN_COUPON_CODE_BULK_CREATE_JOBCreate 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.Input Parameters
Output
Spawn create categories job
Spawn create categories job
KLAVIYO_SPAWN_CREATE_CATEGORIES_JOBCreate 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.Input Parameters
Output
Spawn create items job
Spawn create items job
KLAVIYO_SPAWN_CREATE_ITEMS_JOBCreate 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.Input Parameters
Output
Spawn create variants job
Spawn create variants job
KLAVIYO_SPAWN_CREATE_VARIANTS_JOBInitiate 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.Input Parameters
Output
Spawn delete categories job
Spawn delete categories job
KLAVIYO_SPAWN_DELETE_CATEGORIES_JOBDelete 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.Input Parameters
Output
Spawn delete items job
Spawn delete items job
KLAVIYO_SPAWN_DELETE_ITEMS_JOBDelete 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.Input Parameters
Output
Spawn delete variants job
Spawn delete variants job
KLAVIYO_SPAWN_DELETE_VARIANTS_JOBDelete 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.Input Parameters
Output
Spawn update categories job
Spawn update categories job
Spawn update items job
Spawn update items job
KLAVIYO_SPAWN_UPDATE_ITEMS_JOBYou 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.Input Parameters
Output
Spawn update variants job
Spawn update variants job
KLAVIYO_SPAWN_UPDATE_VARIANTS_JOBCreate 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.Input Parameters
Output
Subscribe profiles
Subscribe profiles
KLAVIYO_SUBSCRIBE_PROFILESSubmit a bulk job to subscribe profiles to marketing, optionally adding them to a list; supports double opt-in and historical imports, and may reset opt-outs for returning users. Caps at 1,000 profiles, with rate limits of 75/s and 700/min; requires lists:write, profiles:write, and subscriptions:write.Input Parameters
Output
Suppress profiles
Suppress profiles
KLAVIYO_SUPPRESS_PROFILESSuppress 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.Input Parameters
Output
Unregister client push token
Unregister client push token
KLAVIYO_UNREGISTER_CLIENT_PUSH_TOKENThis 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.Input Parameters
exchange_id, this is an encrypted identifier used for identifying a profile by Klaviyo”s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.Output
Unsubscribe profiles
Unsubscribe profiles
KLAVIYO_UNSUBSCRIBE_PROFILESOpt-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.Input Parameters
Output
Unsubscribe Profiles Bulk
Unsubscribe Profiles Bulk
Unsuppress profiles
Unsuppress profiles
KLAVIYO_UNSUPPRESS_PROFILESRemove ‘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’.Input Parameters
Output
Unsuppress Profiles (Bulk)
Unsuppress Profiles (Bulk)
KLAVIYO_UNSUPPRESS_PROFILES_BULKSubmit a bulk request to remove USER_SUPPRESSED email marketing suppressions from profiles identified by email address; other suppression reasons remain unchanged. Provide 1–100 email addresses. A 202 response indicates the request was accepted, but does not provide a job ID for monitoring completion.Input Parameters
Output
Update Campaign
Update Campaign
KLAVIYO_UPDATE_CAMPAIGNUpdate a campaign’s settings, including its name, audiences, send options, tracking options, and send strategy; requires campaigns:write. Static send strategies also include default local-time settings when those options are omitted.Input Parameters
Output
Update campaign message
Update campaign message
KLAVIYO_UPDATE_CAMPAIGN_MESSAGEUpdate a campaign messageRate limits:
Burst:
10/sSteady:
150/m Scopes: campaigns:writeInput Parameters
Output
Update catalog category
Update catalog category
KLAVIYO_UPDATE_CATALOG_CATEGORYUpdate a catalog category with the given category ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: catalogs:writeInput Parameters
{integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.{integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.Output
Update Catalog Category Relationships
Update Catalog Category Relationships
KLAVIYO_UPDATE_CATALOG_CATEGORY_RELATIONSHIPSTool to update item relationships for a catalog category. Replaces all existing item relationships with the provided list. Use when you need to associate catalog items with a category or remove existing associations. Pass an empty data array to remove all item relationships from the category. Rate limits: 75/s burst, 700/m steady. Required scope: catalogs:write.Input Parameters
Output
Update catalog category relationships items
Update catalog category relationships items
KLAVIYO_UPDATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSUpdate item relationships for the given category ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: catalogs:writeInput Parameters
Output
Update catalog item
Update catalog item
KLAVIYO_UPDATE_CATALOG_ITEMUpdate a catalog item with the given item ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: catalogs:writeInput Parameters
{integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.{integration}:::{catalog}:::{external_id} (e.g., ‘$custom:::$default:::ITEM-123’). Currently, the only supported integration type is $custom, and the only supported catalog is $default.price on any child variants, using the Update Catalog Variant Endpoint.Output
Update catalog item relationships categories
Update catalog item relationships categories
KLAVIYO_UPDATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESUpdate catalog category relationships for the given item ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: catalogs:writeInput Parameters
Output
Update catalog variant
Update catalog variant
KLAVIYO_UPDATE_CATALOG_VARIANTUpdate a catalog item variant with the given variant ID.Rate limits:
Burst:
75/sSteady:
700/m Scopes: catalogs:writeInput Parameters
{integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.{integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.price on any parent items using the Update Catalog Item Endpoint.1: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. 0 or 2: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.Output
Update coupon
Update coupon
KLAVIYO_UPDATE_COUPONUpdate an existing coupon’s description by coupon ID. The action declares coupons:read and coupons:write scopes.Input Parameters
Output
Update coupon code
Update coupon code
KLAVIYO_UPDATE_COUPON_CODEUpdates a coupon code specified by the given identifier synchronously. We allow updating the ‘status’ and ‘expires_at’ of coupon codes.Rate limits:
Burst:
350/sSteady:
3500/m Scopes: coupon-codes:writeInput Parameters
Output
Update flow status
Update flow status
KLAVIYO_UPDATE_FLOW_STATUSUpdate 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:writeInput Parameters
Output
Update form
Update form
Update image
Update image
Update list
Update list
Update profile
Update profile
KLAVIYO_UPDATE_PROFILEUpdate a Klaviyo profile by ID with supplied attributes. Null-valued fields are omitted from the request; existing custom property keys can be removed using the unset operation. Requires profiles:write accessInput Parameters
Output
Update segment
Update segment
KLAVIYO_UPDATE_SEGMENTUpdate a segment with the given segment ID.Rate limits:
Burst:
1/sSteady:
15/mDaily:
100/d Scopes: segments:writeInput Parameters
Output
Update tag
Update tag
KLAVIYO_UPDATE_TAGUpdate 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:writeInput Parameters
Output
Update tag group
Update tag group
KLAVIYO_UPDATE_TAG_GROUPUpdate the tag group with the given tag group ID. Only a tag group’s name can be changed. A tag group’s exclusive or default value cannot be changed.Rate limits:
Burst:
3/sSteady:
60/m Scopes: tags:read tags:writeInput Parameters
Output
Update template
Update template
KLAVIYO_UPDATE_TEMPLATEUpdate 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.Input Parameters
Output
Update webhook
Update webhook
KLAVIYO_UPDATE_WEBHOOKUpdate the webhook with the given ID. The action declares webhooks:read and webhooks:write scopes; rate limits are burst 1/s and steady 15/m.Input Parameters
Output
Upload image from file
Upload image from file
KLAVIYO_UPLOAD_IMAGE_FROM_FILEUpload an image from a file. If you want to import an image from an existing url or a data uri, use the Upload Image From URL endpoint instead.Rate limits:
Burst:
3/sSteady:
100/mDaily:
100/d Scopes: images:writeInput Parameters
Output
Upload image from url
Upload image from url
KLAVIYO_UPLOAD_IMAGE_FROM_URLImport an image from a URL or data URI. Rate limits: 3/s burst, 100/m steady, and 100/d daily; the tool declares the images:read scope.Input Parameters
data:image/...). Supported image formats: jpeg,png,gif. Maximum image size: 5MB.