Skip to content
Changelog

Report a bug

Klaviyo integration: operations for AI agents

Klaviyo connects to Type.com as an integration. This page lists the 436 operations documented for Claude and Codex in Type.com: 265 read, 123 write, 48 destructive.

About 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

Categories: Marketing & Social

How to connect Klaviyo to Type.com

Connect
Managed OAuth through Pipedream when enabled for your workspace; API key
Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

436 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

436 operations listed.

Accounts

  • Read

    Get Accounts

    Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `accounts:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_accounts.json)

    GET /api/accounts

  • Read

    Get Account

    Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `accounts:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_account.json)

    GET /api/accounts/{id}

Billing

  • Read

    List Billing Usage

    List current-period usage and plan caps for the account. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `usage:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/list_billing_usage.json)

    GET /api/billing-usage

  • Read

    Get Billing Usage

    Get current-period usage and plan cap for a single usage type. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `usage:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_billing_usage.json)

    GET /api/billing-usage/{id}

Brands

  • Read

    Get Brand Logos

    Get all brand logos for the authenticated account. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_logos.json)

    GET /api/brand-logos

  • Read

    Get Brand Buttons

    Get all brand buttons for the authenticated account. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_buttons.json)

    GET /api/brand-buttons

  • Read

    Get Brand Button

    Get the brand button with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_button.json)

    GET /api/brand-buttons/{id}

  • Read

    Get Brand Colors

    Get all brand color groups for the authenticated account. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_colors.json)

    GET /api/brand-colors

  • Read

    Get Brand Color

    Get the brand color group with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_color.json)

    GET /api/brand-colors/{id}

  • Read

    Get Brand Voice

    Get the brand voice for the authenticated company. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_voice.json)

    GET /api/brand-voice/{id}

  • Read

    Get Brand Social Groups

    Get all brand social groups for the authenticated account. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_social_groups.json)

    GET /api/brand-social-groups

  • Read

    Get Brand Social Group

    Get the brand social group with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_social_group.json)

    GET /api/brand-social-groups/{id}

  • Read

    Get Brand Email Defaults

    List the brand email defaults for the authenticated account. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_email_defaults.json)

    GET /api/brand-email-defaults

  • Read

    Get Brand Email Default

    Get the brand email defaults for the authenticated account. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_email_default.json)

    GET /api/brand-email-defaults/{id}

  • Write

    Create Brand Button

    Create a new brand button. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_brand_button.json)

    POST /api/brand-buttons

  • Write

    Update Brand Button

    Update the brand button with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_button.json)

    PATCH /api/brand-buttons/{id}

  • Write

    Create Brand Color

    Create a new brand color group. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_brand_color.json)

    POST /api/brand-colors

  • Write

    Update Brand Color

    Update the brand color group with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_color.json)

    PATCH /api/brand-colors/{id}

  • Write

    Update Brand Voice

    Update the brand voice for the authenticated company. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_voice.json)

    PATCH /api/brand-voice/{id}

  • Write

    Create Brand Social Group

    Create a new brand social group. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_brand_social_group.json)

    POST /api/brand-social-groups

  • Write

    Update Brand Social Group

    Update the brand social group with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_social_group.json)

    PATCH /api/brand-social-groups/{id}

  • Write

    Update Brand Email Default

    Partial update of the brand email defaults for the authenticated account. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_email_default.json)

    PATCH /api/brand-email-defaults/{id}

  • Destructive

    Delete Brand Button

    Delete the brand button with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_brand_button.json)

    DELETE /api/brand-buttons/{id}

  • Destructive

    Delete Brand Color

    Delete the brand color group with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_brand_color.json)

    DELETE /api/brand-colors/{id}

  • Destructive

    Delete Brand Social Group

    Delete the brand social group with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_brand_social_group.json)

    DELETE /api/brand-social-groups/{id}

Campaigns

  • Read

    Get Campaigns

    Get all campaigns, with optional filtering. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaigns.json)

    GET /api/campaigns

  • Read

    Get Campaign

    Get a campaign by ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign.json)

    GET /api/campaigns/{id}

  • Read

    Get Campaign Messages

    Returns campaign messages based on filters. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_messages.json)

    GET /api/campaign-messages

  • Read

    Get Campaign Message

    Get a campaign message by ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_message.json)

    GET /api/campaign-messages/{id}

  • Read

    Get Campaign Send Job

    Get a campaign send job *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_send_job.json)

    GET /api/campaign-send-jobs/{id}

  • Read

    Get Campaign Recipient Estimation Job

    Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_recipient_estimation_job.json)

    GET /api/campaign-recipient-estimation-jobs/{id}

  • Read

    Get Campaign Recipient Estimation

    Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_recipient_estimation.json)

    GET /api/campaign-recipient-estimations/{id}

  • Read

    Get Campaign Audience

    Get the campaign audience with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_audience.json)

    GET /api/campaign-audiences/{id}

  • Read

    Get Campaign Variation

    Get the campaign variation with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_variation.json)

    GET /api/campaign-variations/{id}

  • Read

    Get Campaign for Campaign Message

    Return the related omnicampaign *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_for_campaign_message.json)

    GET /api/campaign-messages/{id}/campaign

  • Read

    Get Campaign ID for Campaign Message

    Returns the ID of the related omnicampaign *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_id_for_campaign_message.json)

    GET /api/campaign-messages/{id}/relationships/campaign

  • Read

    Get Template for Campaign Message

    Return the related template *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` `templates:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_for_campaign_message.json)

    GET /api/campaign-messages/{id}/template

  • Read

    Get Template ID for Campaign Message

    Returns the ID of the related template *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` `templates:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_id_for_campaign_message.json)

    GET /api/campaign-messages/{id}/relationships/template

  • Read

    Get Image for Campaign Message

    Return the related image for a given campaign message *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` `images:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image_for_campaign_message.json)

    GET /api/campaign-messages/{id}/image

  • Read

    Get Image ID for Campaign Message

    Returns the ID of the related image *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` `images:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image_id_for_campaign_message.json)

    GET /api/campaign-messages/{id}/relationships/image

  • Read

    Get Audience for Campaign Message

    Get the campaign audience for the given campaign message ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_audience_for_campaign_message.json)

    GET /api/campaign-messages/{id}/campaign-audience

  • Read

    Get Audience ID for Campaign Message

    Get the campaign audience [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given campaign message ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_audience_id_for_campaign_message.json)

    GET /api/campaign-messages/{id}/relationships/campaign-audience

  • Read

    Get Tags for Campaign

    Return all tags that belong to the given campaign. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `campaigns:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_campaign.json)

    GET /api/campaigns/{id}/tags

  • Read

    Get Tag IDs for Campaign

    Returns the IDs of all tags associated with the given campaign. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `campaigns:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_campaign.json)

    GET /api/campaigns/{id}/relationships/tags

  • Read

    Get Tags for Campaign Message

    Get all tags for the given campaign message ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `campaigns:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_campaign_message.json)

    GET /api/campaign-messages/{id}/tags

  • Read

    Get Tag IDs for Campaign Message

    Get all tag [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given campaign message ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `campaigns:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_campaign_message.json)

    GET /api/campaign-messages/{id}/relationships/tags

  • Read

    Get Messages for Campaign

    Get all messages for the given campaign. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_messages_for_campaign.json)

    GET /api/campaigns/{id}/campaign-messages

  • Read

    Get Message IDs for Campaign

    Get all campaign message [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given campaign ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_message_ids_for_campaign.json)

    GET /api/campaigns/{id}/relationships/campaign-messages

  • Read

    Get Campaign Audiences for Campaign

    Get all campaign audiences for the given campaign ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_audiences_for_campaign.json)

    GET /api/campaigns/{id}/campaign-audiences

  • Read

    Get Audience IDs for Campaign

    Get all campaign audience [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given campaign ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_audience_ids_for_campaign.json)

    GET /api/campaigns/{id}/relationships/campaign-audiences

  • Read

    Get Campaign for Campaign Audience

    Get the campaign for the given campaign audience ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_for_campaign_audience.json)

    GET /api/campaign-audiences/{id}/campaign

  • Read

    Get Campaign ID for Campaign Audience

    Get the campaign [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given campaign audience ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_id_for_campaign_audience.json)

    GET /api/campaign-audiences/{id}/relationships/campaign

  • Read

    Get Campaign Messages for Campaign Audience

    Get all campaign messages for the given campaign audience ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_messages_for_campaign_audience.json)

    GET /api/campaign-audiences/{id}/campaign-messages

  • Read

    Get Message IDs for Campaign Audience

    Get all campaign messages [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given campaign audience ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_message_ids_for_campaign_audience.json)

    GET /api/campaign-audiences/{id}/relationships/campaign-messages

  • Read

    Get Message for Campaign Variation

    Get the campaign message for the given campaign variation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_message_for_campaign_variation.json)

    GET /api/campaign-variations/{id}/campaign-message

  • Read

    Get Message ID for Campaign Variation

    Get the campaign message [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given campaign variation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_message_id_for_campaign_variation.json)

    GET /api/campaign-variations/{id}/relationships/campaign-message

  • Read

    Get Translation for Campaign Variation

    Get the translation for the given campaign variation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_translation_for_campaign_variation.json)

    GET /api/campaign-variations/{id}/translation

  • Read

    Get Translation ID for Campaign Variation

    Get the translation [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given campaign variation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_translation_id_for_campaign_variation.json)

    GET /api/campaign-variations/{id}/relationships/translation

  • Read

    Get Image for Campaign Variation

    Get the image for the given campaign variation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image_for_campaign_variation.json)

    GET /api/campaign-variations/{id}/image

  • Read

    Get Image ID for Campaign Variation

    Get the image [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given campaign variation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image_id_for_campaign_variation.json)

    GET /api/campaign-variations/{id}/relationships/image

  • Read

    Get Variations for Campaign Message

    Get all campaign variations for the given campaign message ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variations_for_campaign_message.json)

    GET /api/campaign-messages/{id}/campaign-variations

  • Read

    Get Variation IDs for Campaign Message

    Get all campaign variation [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given campaign message ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variation_ids_for_campaign_message.json)

    GET /api/campaign-messages/{id}/relationships/campaign-variations

  • Write

    Create Campaign

    Create a campaign with inline audiences, messages, and variations. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_campaign.json)

    POST /api/campaigns

  • Write

    Update Campaign

    Update a campaign with the given campaign ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_campaign.json)

    PATCH /api/campaigns/{id}

  • Write

    Create Campaign Message

    Create a campaign message. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_campaign_message.json)

    POST /api/campaign-messages

  • Write

    Update Campaign Message

    Update a campaign message. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_campaign_message.json)

    PATCH /api/campaign-messages/{id}

  • Write

    Update Campaign Audience

    Update the campaign audience with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_campaign_audience.json)

    PATCH /api/campaign-audiences/{id}

  • Write

    Update Campaign Variation

    Update the campaign variation with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_campaign_variation.json)

    PATCH /api/campaign-variations/{id}

  • Write

    Clone Campaign

    Clones an existing campaign, returning a new campaign based on the original with a new ID and name. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/clone_campaign.json)

    POST /api/campaign-clone

  • Write

    Assign Template to Campaign Message

    Creates a non-reusable version of the template and assigns it to the message. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/assign_template_to_campaign_message.json)

    POST /api/campaign-message-assign-template

  • Write

    Send Campaign

    Trigger a campaign to send asynchronously *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/send_campaign.json)

    POST /api/campaign-send-jobs

  • Write

    Refresh Campaign Recipient Estimation

    Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/refresh_campaign_recipient_estimation.json)

    POST /api/campaign-recipient-estimation-jobs

  • Write

    Create Campaign Audience

    Create a campaign audience. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_campaign_audience.json)

    POST /api/campaign-audiences

  • Write

    Clone Campaign Audience

    Clone an existing campaign audience to a target campaign. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/clone_campaign_audience.json)

    POST /api/campaign-audience-clone

  • Write

    Clone Campaign Message

    Clone an existing campaign message to a target audience. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/clone_campaign_message.json)

    POST /api/campaign-message-clone

  • Write

    Create Campaign Variation

    Create a campaign variation. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_campaign_variation.json)

    POST /api/campaign-variations

  • Write

    Schedule Campaign Message

    Schedule a single campaign message. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/schedule_campaign_message.json)

    POST /api/campaign-message-schedule

  • Write

    Update Campaign Message Schedule

    Cancel or revert a scheduled campaign message. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_campaign_message_schedule.json)

    PATCH /api/campaign-message-schedule/{id}

  • Write

    Update Image for Campaign Message

    Update a campaign message image *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` `images:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_image_for_campaign_message.json)

    PATCH /api/campaign-messages/{id}/relationships/image

  • Destructive

    Delete Campaign

    Delete a campaign with the given campaign ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_campaign.json)

    DELETE /api/campaigns/{id}

  • Destructive

    Delete Campaign Message

    Delete a campaign message. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_campaign_message.json)

    DELETE /api/campaign-messages/{id}

  • Destructive

    Cancel Campaign Send

    Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/cancel_campaign_send.json)

    PATCH /api/campaign-send-jobs/{id}

  • Destructive

    Delete Campaign Audience

    Delete the campaign audience with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_campaign_audience.json)

    DELETE /api/campaign-audiences/{id}

  • Destructive

    Delete Campaign Variation

    Delete the campaign variation with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_campaign_variation.json)

    DELETE /api/campaign-variations/{id}

Catalogs

  • Read

    Get Catalog Items

    Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 items per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_items.json)

    GET /api/catalog-items

  • Read

    Get Catalog Item

    Get a specific catalog item with the given item ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_item.json)

    GET /api/catalog-items/{id}

  • Read

    Get Catalog Variants

    Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 variants per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_variants.json)

    GET /api/catalog-variants

  • Read

    Get Catalog Variant

    Get a catalog item variant with the given variant ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_variant.json)

    GET /api/catalog-variants/{id}

  • Read

    Get Catalog Categories

    Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 categories per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_categories.json)

    GET /api/catalog-categories

  • Read

    Get Catalog Category

    Get a catalog category with the given category ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_category.json)

    GET /api/catalog-categories/{id}

  • Read

    Get Bulk Create Catalog Items Jobs

    Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_catalog_items_jobs.json)

    GET /api/catalog-item-bulk-create-jobs

  • Read

    Get Bulk Create Catalog Items Job

    Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_catalog_items_job.json)

    GET /api/catalog-item-bulk-create-jobs/{job_id}

  • Read

    Get Bulk Update Catalog Items Jobs

    Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_catalog_items_jobs.json)

    GET /api/catalog-item-bulk-update-jobs

  • Read

    Get Bulk Update Catalog Items Job

    Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_catalog_items_job.json)

    GET /api/catalog-item-bulk-update-jobs/{job_id}

  • Read

    Get Bulk Delete Catalog Items Jobs

    Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_catalog_items_jobs.json)

    GET /api/catalog-item-bulk-delete-jobs

  • Read

    Get Bulk Delete Catalog Items Job

    Get a catalog item bulk delete job with the given job ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_catalog_items_job.json)

    GET /api/catalog-item-bulk-delete-jobs/{job_id}

  • Read

    Get Bulk Create Variants Jobs

    Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_variants_jobs.json)

    GET /api/catalog-variant-bulk-create-jobs

  • Read

    Get Bulk Create Variants Job

    Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_variants_job.json)

    GET /api/catalog-variant-bulk-create-jobs/{job_id}

  • Read

    Get Bulk Update Variants Jobs

    Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_variants_jobs.json)

    GET /api/catalog-variant-bulk-update-jobs

  • Read

    Get Bulk Update Variants Job

    Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_variants_job.json)

    GET /api/catalog-variant-bulk-update-jobs/{job_id}

  • Read

    Get Bulk Delete Variants Jobs

    Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_variants_jobs.json)

    GET /api/catalog-variant-bulk-delete-jobs

  • Read

    Get Bulk Delete Variants Job

    Get a catalog variant bulk delete job with the given job ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_variants_job.json)

    GET /api/catalog-variant-bulk-delete-jobs/{job_id}

  • Read

    Get Bulk Create Categories Jobs

    Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_categories_jobs.json)

    GET /api/catalog-category-bulk-create-jobs

  • Read

    Get Bulk Create Categories Job

    Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_categories_job.json)

    GET /api/catalog-category-bulk-create-jobs/{job_id}

  • Read

    Get Bulk Update Categories Jobs

    Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_categories_jobs.json)

    GET /api/catalog-category-bulk-update-jobs

  • Read

    Get Bulk Update Categories Job

    Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_categories_job.json)

    GET /api/catalog-category-bulk-update-jobs/{job_id}

  • Read

    Get Bulk Delete Categories Jobs

    Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_categories_jobs.json)

    GET /api/catalog-category-bulk-delete-jobs

  • Read

    Get Bulk Delete Categories Job

    Get a catalog category bulk delete job with the given job ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_categories_job.json)

    GET /api/catalog-category-bulk-delete-jobs/{job_id}

  • Read

    Get Items for Catalog Category

    Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_items_for_catalog_category.json)

    GET /api/catalog-categories/{id}/items

  • Read

    Get Item IDs for Catalog Category

    Get all items in the given category ID. Returns a maximum of 100 items per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_item_ids_for_catalog_category.json)

    GET /api/catalog-categories/{id}/relationships/items

  • Read

    Get Variants for Catalog Item

    Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variants_for_catalog_item.json)

    GET /api/catalog-items/{id}/variants

  • Read

    Get Variant IDs for Catalog Item

    Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variant_ids_for_catalog_item.json)

    GET /api/catalog-items/{id}/relationships/variants

  • Read

    Get Categories for Catalog Item

    Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_categories_for_catalog_item.json)

    GET /api/catalog-items/{id}/categories

  • Read

    Get Category IDs for Catalog Item

    Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_category_ids_for_catalog_item.json)

    GET /api/catalog-items/{id}/relationships/categories

  • Write

    Create Catalog Item

    Create a new catalog item. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_item.json)

    POST /api/catalog-items

  • Write

    Update Catalog Item

    Update a catalog item with the given item ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_catalog_item.json)

    PATCH /api/catalog-items/{id}

  • Write

    Create Catalog Variant

    Create a new variant for a related catalog item. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_variant.json)

    POST /api/catalog-variants

  • Write

    Update Catalog Variant

    Update a catalog item variant with the given variant ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_catalog_variant.json)

    PATCH /api/catalog-variants/{id}

  • Write

    Create Catalog Category

    Create a new catalog category. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_category.json)

    POST /api/catalog-categories

  • Write

    Update Catalog Category

    Update a catalog category with the given category ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_catalog_category.json)

    PATCH /api/catalog-categories/{id}

  • Write

    Bulk Create Catalog Items

    Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_items.json)

    POST /api/catalog-item-bulk-create-jobs

  • Write

    Bulk Update Catalog Items

    Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_items.json)

    POST /api/catalog-item-bulk-update-jobs

  • Write

    Bulk Create Catalog Variants

    Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_variants.json)

    POST /api/catalog-variant-bulk-create-jobs

  • Write

    Bulk Update Catalog Variants

    Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_variants.json)

    POST /api/catalog-variant-bulk-update-jobs

  • Write

    Bulk Create Catalog Categories

    Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_categories.json)

    POST /api/catalog-category-bulk-create-jobs

  • Write

    Bulk Update Catalog Categories

    Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_categories.json)

    POST /api/catalog-category-bulk-update-jobs

  • Write

    Create Back In Stock Subscription

    Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details. This endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription). *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:write` `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_back_in_stock_subscription.json)

    POST /api/back-in-stock-subscriptions

  • Write

    Add Items to Catalog Category

    Create a new item relationship for the given category ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/add_items_to_catalog_category.json)

    POST /api/catalog-categories/{id}/relationships/items

  • Write

    Update Items for Catalog Category

    Update item relationships for the given category ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_items_for_catalog_category.json)

    PATCH /api/catalog-categories/{id}/relationships/items

  • Write

    Add Categories to Catalog Item

    Create a new catalog category relationship for the given item ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/add_categories_to_catalog_item.json)

    POST /api/catalog-items/{id}/relationships/categories

  • Write

    Update Categories for Catalog Item

    Update catalog category relationships for the given item ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_categories_for_catalog_item.json)

    PATCH /api/catalog-items/{id}/relationships/categories

  • Destructive

    Delete Catalog Item

    Delete a catalog item with the given item ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_catalog_item.json)

    DELETE /api/catalog-items/{id}

  • Destructive

    Delete Catalog Variant

    Delete a catalog item variant with the given variant ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_catalog_variant.json)

    DELETE /api/catalog-variants/{id}

  • Destructive

    Delete Catalog Category

    Delete a catalog category using the given category ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_catalog_category.json)

    DELETE /api/catalog-categories/{id}

  • Destructive

    Bulk Delete Catalog Items

    Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_items.json)

    POST /api/catalog-item-bulk-delete-jobs

  • Destructive

    Bulk Delete Catalog Variants

    Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_variants.json)

    POST /api/catalog-variant-bulk-delete-jobs

  • Destructive

    Bulk Delete Catalog Categories

    Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_categories.json)

    POST /api/catalog-category-bulk-delete-jobs

  • Destructive

    Remove Items from Catalog Category

    Delete item relationships for the given category ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_items_from_catalog_category.json)

    DELETE /api/catalog-categories/{id}/relationships/items

  • Destructive

    Remove Categories from Catalog Item

    Delete catalog category relationships for the given item ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `catalogs:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_categories_from_catalog_item.json)

    DELETE /api/catalog-items/{id}/relationships/categories

Conversations

  • Write

    Create Conversation Message

    Send an outbound message to a conversation. Requires account-level enablement. To request access, reach out in the [developer community](https://community.klaviyo.com/groups/developer-group-64). *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `conversations:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_conversation_message.json)

    POST /api/conversation-messages

Coupons

  • Read

    Get Coupons

    Get all coupons in an account. To learn more, see our [Coupons API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_coupons_api). *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `coupons:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupons.json)

    GET /api/coupons

  • Read

    Get Coupon

    Get a specific coupon with the given coupon ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `coupons:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon.json)

    GET /api/coupons/{id}

  • Read

    Get Coupon Codes

    Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles. A coupon/coupons or a profile/profiles must be provided as required filter params. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_codes.json)

    GET /api/coupon-codes

  • Read

    Get Coupon Code

    Returns a Coupon Code specified by the given identifier. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_code.json)

    GET /api/coupon-codes/{id}

  • Read

    Get Bulk Create Coupon Code Jobs

    Get all coupon code bulk create jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_coupon_code_jobs.json)

    GET /api/coupon-code-bulk-create-jobs

  • Read

    Get Bulk Create Coupon Codes Job

    Get a coupon code bulk create job with the given job ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_coupon_codes_job.json)

    GET /api/coupon-code-bulk-create-jobs/{job_id}

  • Read

    Get Coupon For Coupon Code

    Get the coupon associated with a given coupon code ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `coupons:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_for_coupon_code.json)

    GET /api/coupon-codes/{id}/coupon

  • Read

    Get Coupon ID for Coupon Code

    Gets the coupon relationship associated with the given coupon code id *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `coupons:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_id_for_coupon_code.json)

    GET /api/coupon-codes/{id}/relationships/coupon

  • Read

    Get Coupon Codes for Coupon

    Gets a list of coupon codes associated with the given coupon id *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_codes_for_coupon.json)

    GET /api/coupons/{id}/coupon-codes

  • Read

    Get Coupon Code IDs for Coupon

    Gets a list of coupon code relationships associated with the given coupon id *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `coupon-codes:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_code_ids_for_coupon.json)

    GET /api/coupons/{id}/relationships/coupon-codes

  • Write

    Create Coupon

    Creates a new coupon. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `coupons:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_coupon.json)

    POST /api/coupons

  • Write

    Update Coupon

    *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `coupons:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_coupon.json)

    PATCH /api/coupons/{id}

  • Write

    Create Coupon Code

    Synchronously creates a coupon code for the given coupon. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `coupon-codes:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_coupon_code.json)

    POST /api/coupon-codes

  • Write

    Update Coupon Code

    Updates a coupon code specified by the given identifier synchronously. We allow updating the 'status' and 'expires_at' of coupon codes. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `coupon-codes:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_coupon_code.json)

    PATCH /api/coupon-codes/{id}

  • Write

    Bulk Create Coupon Codes

    Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max number of coupon codes per job we allow for is 1000. Max number of jobs queued at once we allow for is 100. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `coupon-codes:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_coupon_codes.json)

    POST /api/coupon-code-bulk-create-jobs

  • Destructive

    Delete Coupon

    Delete the coupon with the given coupon ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `coupons:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_coupon.json)

    DELETE /api/coupons/{id}

  • Destructive

    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 *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `coupon-codes:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_coupon_code.json)

    DELETE /api/coupon-codes/{id}

Custom Objects

  • Read

    Get Data Sources

    Get all data sources in an account. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_data_sources.json)

    GET /api/data-sources

  • Read

    Get Data Source

    Retrieve a data source in an account. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_data_source.json)

    GET /api/data-sources/{id}

  • Read

    Get Source Mapping

    Get the source mapping with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_source_mapping.json)

    GET /api/source-mappings/{id}

  • Read

    Get Object Types

    Get all object types in an account. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_types.json)

    GET /api/object-types

  • Read

    Get Object Type

    Get the object type with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_type.json)

    GET /api/object-types/{id}

  • Read

    Get Object Schema

    Get the object schema with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_schema.json)

    GET /api/object-schemas/{id}

  • Read

    Get Object Record

    Get the object record with the given compound ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_record.json)

    GET /api/object-records/{id}

  • Read

    Get Records for Object Type

    Get all object records for a given object type. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_records_for_object_type.json)

    GET /api/object-types/{id}/object-records

  • Read

    Get Record IDs for Object Type

    Get all object records for a given object type. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_record_ids_for_object_type.json)

    GET /api/object-types/{id}/relationships/object-records

  • Read

    Get Ingestion Logs for Object Type

    Get the ingestion logs for a given object type. Only ingestion failures are logged — the absence of a log entry for a record does not mean the record was ingested successfully. Logs are retained for 14 days; time filters outside that window return an empty page. Results are returned newest first with a fixed page size of 50. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ingestion_logs_for_object_type.json)

    GET /api/object-types/{id}/object-ingestion-logs

  • Read

    Get Ingestion Log IDs for Object Type

    Get the ingestion logs for a given object type. Only ingestion failures are logged — the absence of a log entry for a record does not mean the record was ingested successfully. Logs are retained for 14 days; time filters outside that window return an empty page. Results are returned newest first with a fixed page size of 50. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ingestion_log_ids_for_object_type.json)

    GET /api/object-types/{id}/relationships/object-ingestion-logs

  • Read

    Get Current Schema for Object Type

    Get current schema for an object type *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_current_schema_for_object_type.json)

    GET /api/object-types/{id}/current-schema

  • Read

    Get Current Schema ID for Object Type

    Get current schema for an object type *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_current_schema_id_for_object_type.json)

    GET /api/object-types/{id}/relationships/current-schema

  • Read

    Get Draft Schema for Object Type

    Get draft schema for an object type *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_draft_schema_for_object_type.json)

    GET /api/object-types/{id}/draft-schema

  • Read

    Get Draft Schema ID for Object Type

    Get draft schema for an object type *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_draft_schema_id_for_object_type.json)

    GET /api/object-types/{id}/relationships/draft-schema

  • Read

    Get Schema Versions for Object Type

    Get all schema versions for an object type *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_schema_versions_for_object_type.json)

    GET /api/object-types/{id}/schema-versions

  • Read

    Get Schema Version IDs for Object Type

    Get all schema versions for an object type *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_schema_version_ids_for_object_type.json)

    GET /api/object-types/{id}/relationships/schema-versions

  • Read

    Get Object Type Relationships

    Get related object types for an object type *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_type_relationships.json)

    GET /api/object-types/{id}/relationships/object-types

  • Read

    Get Profile Type Relationships

    Get related profile object types for an object type *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_type_relationships.json)

    GET /api/object-types/{id}/relationships/profile-object-types

  • Read

    Get Source Mapping for Object Schema

    Get source mapping for an object schema *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_source_mapping_for_object_schema.json)

    GET /api/object-schemas/{id}/source-mapping

  • Read

    Get Source Mapping ID for Object Schema

    Get source mapping for an object schema *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_source_mapping_id_for_object_schema.json)

    GET /api/object-schemas/{id}/relationships/source-mapping

  • Read

    Get Object Schema Relationships

    Get related object schemas for an object schema *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_schema_relationships.json)

    GET /api/object-schemas/{id}/relationships/object-schemas

  • Read

    Get Profile Schema Relationships

    Get related profile object schemas for an object schema *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_schema_relationships.json)

    GET /api/object-schemas/{id}/relationships/profile-object-schemas

  • Write

    Create Data Source

    Create a new data source in an account *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_data_source.json)

    POST /api/data-sources

  • Write

    Update Source Mapping

    Update the source mapping with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_source_mapping.json)

    PATCH /api/source-mappings/{id}

  • Write

    Create Object Type

    Create an object type. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_object_type.json)

    POST /api/object-types

  • Write

    Update Object Schema

    Update the object schema with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_object_schema.json)

    PATCH /api/object-schemas/{id}

  • Write

    Bulk Create Data Source Records

    Create a bulk data source record import job to create a batch of records. Accepts up to 500 records per request. The maximum allowed payload size is 4MB. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview). *Rate limits*: Burst: `3/s` Steady: `15/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_data_source_records.json)

    POST /api/data-source-record-bulk-create-jobs

  • Write

    Create Data Source Record

    Create a data source record import job to create a single record. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview). *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_data_source_record.json)

    POST /api/data-source-record-create-jobs

  • Write

    Create Object Schema

    Create an object schema. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_object_schema.json)

    POST /api/object-schemas

  • Write

    Create Object Schema Relationship

    Create a relationship between object schemas. Note that flow filtering and segmentation are currently not supported for object-to-object relationships. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_object_schema_relationship.json)

    POST /api/object-schemas/{id}/relationships/object-schemas

  • Write

    Update Object Schema Relationship

    Update a relationship between object schemas *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_object_schema_relationship.json)

    PATCH /api/object-schemas/{id}/relationships/object-schemas

  • Write

    Create Profile Schema Relationship

    Create a relationship between an object schema and a profile *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_profile_schema_relationship.json)

    POST /api/object-schemas/{id}/relationships/profile-object-schemas

  • Write

    Update Profile Schema Relationship

    Update a relationship between an object schema and a profile *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_profile_schema_relationship.json)

    PATCH /api/object-schemas/{id}/relationships/profile-object-schemas

  • Destructive

    Delete Data Source

    Delete a data source in an account. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_data_source.json)

    DELETE /api/data-sources/{id}

  • Destructive

    Delete Object Type

    Delete the object type with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_object_type.json)

    DELETE /api/object-types/{id}

  • Destructive

    Bulk Delete Object Records

    Delete a batch of object records. Accepts up to 500 object record IDs per request. The maximum allowed payload size is 5MB. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_object_records.json)

    POST /api/object-record-bulk-delete-jobs

  • Destructive

    Delete Object Schema Relationship

    Delete a relationship between object schemas *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_object_schema_relationship.json)

    DELETE /api/object-schemas/{id}/relationships/object-schemas

  • Destructive

    Delete Profile Schema Relationship

    Delete a relationship between an object schema and a profile *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_profile_schema_relationship.json)

    DELETE /api/object-schemas/{id}/relationships/profile-object-schemas

Data Privacy

  • Destructive

    Request Profile Deletion

    Request a deletion for the profiles corresponding to one of the following identifiers: `email`, `phone_number`, or `id`. If multiple identifiers are provided, we will return an error. All profiles that match the provided identifier will be deleted. The deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the [Deleted Profiles page](https://www.klaviyo.com/account/deleted). For more information on the deletion process, please refer to our [Help Center docs on how to handle GDPR and CCPA deletion requests](https://help.klaviyo.com/hc/en-us/articles/360004217631-How-to-Handle-GDPR-Requests#record-gdpr-and-ccpa%20%20-deletion-requests2). *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `data-privacy:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/request_profile_deletion.json)

    POST /api/data-privacy-deletion-jobs

Events

  • Read

    Get Events

    Get all events in an account Requests can be sorted by the following fields: `datetime`, `timestamp` [Custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview) are not supported in the `metric_id` filter. Returns a maximum of 200 events per page. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `events:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_events.json)

    GET /api/events

  • Read

    Get Event

    Get an event with the given event ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `events:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_event.json)

    GET /api/events/{id}

  • Read

    Get Metric for Event

    Get the metric for an event with the given event ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `events:read` `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_event.json)

    GET /api/events/{id}/metric

  • Read

    Get Metric ID for Event

    Get a list of related Metrics for an Event *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `events:read` `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_id_for_event.json)

    GET /api/events/{id}/relationships/metric

  • Read

    Get Profile for Event

    Get the profile associated with an event with the given event ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `events:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_for_event.json)

    GET /api/events/{id}/profile

  • Read

    Get Profile ID for Event

    Get profile [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for an event with the given event ID. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `events:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_id_for_event.json)

    GET /api/events/{id}/relationships/profile

  • Write

    Create Event

    Create a new event to track a profile's activity. Note that this endpoint allows you to create a new profile or update an existing profile's properties. At a minimum, profile and metric objects should include at least one profile identifier (e.g., `id`, `email`, or `phone_number`) and the metric `name`, respectively. Successful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `events:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_event.json)

    POST /api/events

  • Write

    Bulk Create Events

    Create a batch of events for one or more profiles. Note that this endpoint allows you to create new profiles or update existing profile properties. At a minimum, profile and metric objects should include at least one profile identifier (e.g., `id`, `email`, or `phone_number`) and the metric `name`, respectively. Accepts up to 1,000 events per request. The maximum allowed payload size is 5MB. A single string cannot exceed 100KB. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `events:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_events.json)

    POST /api/event-bulk-create-jobs

Flows

  • Read

    Get Flows

    Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows.json)

    GET /api/flows

  • Read

    Get Flow

    Get a flow with the given flow ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow.json)

    GET /api/flows/{id}

  • Read

    Get Flow Action

    Get a flow action from a flow with the given flow action ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_action.json)

    GET /api/flow-actions/{id}

  • Read

    Get Flow Message

    Get a flow message from a flow with the given flow message ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_message.json)

    GET /api/flow-messages/{id}

  • Read

    Get Actions for Flow

    Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_actions_for_flow.json)

    GET /api/flows/{id}/flow-actions

  • Read

    Get Action IDs for Flow

    Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Returns a maximum of 100 flows per request, which can be paginated with cursor-based pagination. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_ids_for_flow.json)

    GET /api/flows/{id}/relationships/flow-actions

  • Read

    Get Tags for Flow

    Return all tags associated with the given flow ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_flow.json)

    GET /api/flows/{id}/tags

  • Read

    Get Tag IDs for Flow

    Return the tag IDs of all tags associated with the given flow. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_flow.json)

    GET /api/flows/{id}/relationships/tags

  • Read

    Get Flow for Flow Action

    Get the flow associated with the given action ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_for_flow_action.json)

    GET /api/flow-actions/{id}/flow

  • Read

    Get Flow ID for Flow Action

    Get the flow associated with the given action ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_id_for_flow_action.json)

    GET /api/flow-actions/{id}/relationships/flow

  • Read

    Get Messages For Flow Action

    Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_action_messages.json)

    GET /api/flow-actions/{id}/flow-messages

  • Read

    Get Message IDs for Flow Action

    Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_message_ids_for_flow_action.json)

    GET /api/flow-actions/{id}/relationships/flow-messages

  • Read

    Get Action for Flow Message

    Get the flow action for a flow message with the given message ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_for_flow_message.json)

    GET /api/flow-messages/{id}/flow-action

  • Read

    Get Action ID for Flow Message

    Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_id_for_flow_message.json)

    GET /api/flow-messages/{id}/relationships/flow-action

  • Read

    Get Template for Flow Message

    Return the related template *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `templates:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_for_flow_message.json)

    GET /api/flow-messages/{id}/template

  • Read

    Get Template ID for Flow Message

    Returns the ID of the related template *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `templates:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_id_for_flow_message.json)

    GET /api/flow-messages/{id}/relationships/template

  • Write

    Create Flow

    Create a new flow using an encoded flow definition. New objects within the flow definition, such as actions, will need to use a `temporary_id` field for identification. These will be replaced with traditional `id` fields after successful creation. A successful request will return the new definition to you. *Rate limits*: Burst: `1/s` Steady: `15/m` Daily: `100/d` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_flow.json)

    POST /api/flows

  • Write

    Update Flow Status

    Update the status of a flow with the given flow ID, and all actions in that flow. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_flow.json)

    PATCH /api/flows/{id}

  • Write

    Update Flow Action

    Update a flow action. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_flow_action.json)

    PATCH /api/flow-actions/{id}

  • Write

    Create Flow Action

    Insert a new action into an existing flow. Choose exactly one placement mechanism: - Use `anchor-action` to insert after an existing action on one of its outgoing links. The selected anchor link must equal the new action's `temporary_id`, and the new action definition must not include links. Use an anchor to append to a path or insert into an empty conditional or multi-branch path. - Use `definition.links.next` to insert before an existing downstream action. The server reconnects that action after the new one. - Use `relationships.flow` only to insert the first action into a trigger-only flow whose initialized start path has no actions. `anchor-action`, links on the new definition, and `relationships.flow` are mutually exclusive. Standard linear actions, standard WhatsApp actions, and multi-branch splits are supported. Conditional splits, trigger splits, action-output splits, A/B tests, content experiments, and Automated Conversations actions cannot be inserted. Communication actions are created in Draft and may need content or template configuration before activation. Always-live timing and logic actions require `allow_live_action: true` when inserted into a live flow and can immediately affect profiles already progressing through that flow. A `201` response confirms that the action was created. The action may take a short time to become available to flow execution. This endpoint is not idempotent: retrying after an unknown result can create a duplicate action, and `temporary_id` is not an idempotency key. Responses use persisted values. These can include server-generated multi-branch branch IDs, omission of the request-only `joined` marker, generated message or webhook defaults, and a cloned email template ID that differs from the supplied template ID. Invalid placement, unavailable anchors, and missing live-action opt-in return standard JSON:API errors with field pointers. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_flow_action.json)

    POST /api/flow-actions

  • Destructive

    Delete Flow

    Delete a flow with the given flow ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_flow.json)

    DELETE /api/flows/{id}

  • Destructive

    Delete Flow Action

    Delete a flow action. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_flow_action.json)

    DELETE /api/flow-actions/{id}

Forms

  • Read

    Get Forms

    Get all forms in an account. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_forms.json)

    GET /api/forms

  • Read

    Get Form

    Get the form with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form.json)

    GET /api/forms/{id}

  • Read

    Get Form Version

    Get the form version with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_version.json)

    GET /api/form-versions/{id}

  • Read

    Get Versions for Form

    Get the form versions for the given form. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_versions_for_form.json)

    GET /api/forms/{id}/form-versions

  • Read

    Get Version IDs for Form

    Get the IDs of the form versions for the given form. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_version_ids_for_form.json)

    GET /api/forms/{id}/relationships/form-versions

  • Read

    Get Form for Form Version

    Get the form associated with the given form version. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_for_form_version.json)

    GET /api/form-versions/{id}/form

  • Read

    Get Form ID for Form Version

    Get the ID of the form associated with the given form version. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_id_for_form_version.json)

    GET /api/form-versions/{id}/relationships/form

  • Write

    Create Form

    Create a new form. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_form.json)

    POST /api/forms

  • Write

    Update Form

    Update a form. Only submitted attributes change, and `definition` replaces the stored definition. Live versions and form lifecycle fields cannot be edited. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_form.json)

    PATCH /api/forms/{id}

  • Write

    Publish Form

    Publish the draft version of a form. The publish completes synchronously; the returned job resource cannot be retrieved afterwards. Forms with a draft A/B test are not supported and must be published from the form editor. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/publish_form.json)

    POST /api/form-publish-jobs

  • Destructive

    Delete Form

    Delete a given form. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_form.json)

    DELETE /api/forms/{id}

  • Destructive

    Unpublish Form

    Unpublish the live version of a form. The unpublish completes synchronously; the returned job resource cannot be retrieved afterwards. Forms with a live A/B test are not supported and must be unpublished from the form editor. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/unpublish_form.json)

    POST /api/form-unpublish-jobs

Images

  • Read

    Get Images

    Get all images in an account. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `images:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_images.json)

    GET /api/images

  • Read

    Get Image

    Get the image with the given image ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `images:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image.json)

    GET /api/images/{id}

  • Write

    Upload Image From URL

    Import an image from a url or data uri. If you want to upload an image from a file, use the Upload Image From File endpoint instead. *Rate limits*: Burst: `3/s` Steady: `100/m` Daily: `100/d` **Scopes:** `images:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/upload_image_from_url.json)

    POST /api/images

  • Write

    Update Image

    Update the image with the given image ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `images:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_image.json)

    PATCH /api/images/{id}

  • Write

    Upload Image From File

    Upload an image from a file. If you want to import an image from an existing url or a data uri, use the Upload Image From URL endpoint instead. *Rate limits*: Burst: `3/s` Steady: `100/m` Daily: `500/d` **Scopes:** `images:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/upload_image_from_file.json)

    POST /api/image-upload

Lists

  • Read

    Get Lists

    Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `lists:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_lists.json)

    GET /api/lists

  • Read

    Get List

    Get a list with the given list ID. *Rate limits*: Burst: `75/s` Steady: `750/m` Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request: Burst: `1/s` Steady: `15/m` To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list.json)

    GET /api/lists/{id}

  • Read

    Get Tags for List

    Return all tags associated with the given list ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `lists:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_list.json)

    GET /api/lists/{id}/tags

  • Read

    Get Tag IDs for List

    Return all tags associated with the given list ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `lists:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_list.json)

    GET /api/lists/{id}/relationships/tags

  • Read

    Get Profiles for List

    Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at` *Rate limits*: Burst: `75/s` Steady: `750/m` Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request: Burst: `10/s` Steady: `150/m` To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_list.json)

    GET /api/lists/{id}/profiles

  • Read

    Get Profile IDs for List

    Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID. *Rate limits*: Burst: `75/s` Steady: `750/m` Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request: Burst: `10/s` Steady: `150/m` To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_list.json)

    GET /api/lists/{id}/relationships/profiles

  • Read

    Get Flows Triggered by List

    Get all flows where the given list ID is being used as the trigger. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` `lists:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_list.json)

    GET /api/lists/{id}/flow-triggers

  • Read

    Get IDs for Flows Triggered by List

    Get the IDs of all flows where the given list is being used as the trigger. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` `lists:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_list.json)

    GET /api/lists/{id}/relationships/flow-triggers

  • Write

    Create List

    Create a new list. *Rate limits*: Burst: `10/s` Steady: `150/m` Daily: `150/d` **Scopes:** `lists:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_list.json)

    POST /api/lists

  • Write

    Update List

    Update the name of a list with the given list ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_list.json)

    PATCH /api/lists/{id}

  • Write

    Add Profiles to List

    Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) to receive email marketing, SMS marketing, or both. This endpoint accepts a maximum of 1000 profiles per call. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:write` `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/add_profiles_to_list.json)

    POST /api/lists/{id}/relationships/profiles

  • Destructive

    Delete List

    Delete a list with the given list ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_list.json)

    DELETE /api/lists/{id}

  • Destructive

    Remove Profiles from List

    Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:write` `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_profiles_from_list.json)

    DELETE /api/lists/{id}/relationships/profiles

Metrics

  • Read

    Get Metrics

    Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metrics.json)

    GET /api/metrics

  • Read

    Get Metric

    Get a metric with the given metric ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric.json)

    GET /api/metrics/{id}

  • Read

    Get Metric Property

    Get a metric property with the given metric property ID. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_property.json)

    GET /api/metric-properties/{id}

  • Read

    Get Custom Metrics

    Get all custom metrics in an account. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metrics.json)

    GET /api/custom-metrics

  • Read

    Get Custom Metric

    Get a custom metric with the given custom metric ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric.json)

    GET /api/custom-metrics/{id}

  • Read

    Get Mapped Metrics

    Get all mapped metrics in an account. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_mapped_metrics.json)

    GET /api/mapped-metrics

  • Read

    Get Mapped Metric

    Get the mapped metric with the given ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_mapped_metric.json)

    GET /api/mapped-metrics/{id}

  • Read

    Query Metric Aggregates

    Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events (not to be confused with [custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview), which are not supported at this time). Queries must be passed in the JSON body of your `POST` request. To request campaign and flow performance data that matches the data shown in Klaviyo's UI, we recommend the [Reporting API](https://developers.klaviyo.com/en/reference/reporting_api_overview). Results can be filtered and grouped by time, event, or profile dimensions. To learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint). For a comprehensive list of request body parameters, native Klaviyo metrics, and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes). *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_metric_aggregates.json)

    POST /api/metric-aggregates

  • Read

    Get Flows Triggered by Metric

    Get all flows where the given metric is being used as the trigger. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `flows:read` `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_metric.json)

    GET /api/metrics/{id}/flow-triggers

  • Read

    Get IDs for Flows Triggered by Metric

    Get the IDs of all flows where the given metric is being used as the trigger. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `flows:read` `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_metric.json)

    GET /api/metrics/{id}/relationships/flow-triggers

  • Read

    Get Properties for Metric

    Get the metric properties for the given metric ID. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_properties_for_metric.json)

    GET /api/metrics/{id}/metric-properties

  • Read

    Get Property IDs for Metric

    Get the IDs of metric properties for the given metric. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_property_ids_for_metric.json)

    GET /api/metrics/{id}/relationships/metric-properties

  • Read

    Get Metric for Metric Property

    Get the metric for the given metric property ID. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_metric_property.json)

    GET /api/metric-properties/{id}/metric

  • Read

    Get Metric ID for Metric Property

    Get the ID of the metric for the given metric property. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_id_for_metric_property.json)

    GET /api/metric-properties/{id}/relationships/metric

  • Read

    Get Metrics for Custom Metric

    Get all metrics for the given custom metric ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metrics_for_custom_metric.json)

    GET /api/custom-metrics/{id}/metrics

  • Read

    Get Metric IDs for Custom Metric

    Get all metrics for the given custom metric ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_ids_for_custom_metric.json)

    GET /api/custom-metrics/{id}/relationships/metrics

  • Read

    Get Metric for Mapped Metric

    Get the metric for the given mapped metric ID (if applicable). *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_mapped_metric.json)

    GET /api/mapped-metrics/{id}/metric

  • Read

    Get Metric ID for Mapped Metric

    Get the ID of the metric for the given mapped metric. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_id_for_mapped_metric.json)

    GET /api/mapped-metrics/{id}/relationships/metric

  • Read

    Get Custom Metric for Mapped Metric

    Get the custom metric for the given mapped metric ID (if applicable). *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric_for_mapped_metric.json)

    GET /api/mapped-metrics/{id}/custom-metric

  • Read

    Get Custom Metric ID for Mapped Metric

    Get the ID of the custom metric for the given mapped metric. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric_id_for_mapped_metric.json)

    GET /api/mapped-metrics/{id}/relationships/custom-metric

  • Write

    Create Custom Metric

    Create a new custom metric. Custom metric objects must include a `name` and `definition`. *Rate limits*: Burst: `1/s` Steady: `15/m` Daily: `15/d` **Scopes:** `metrics:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_custom_metric.json)

    POST /api/custom-metrics

  • Write

    Update Custom Metric

    Update a custom metric with the given custom metric ID. *Rate limits*: Burst: `1/s` Steady: `15/m` Daily: `15/d` **Scopes:** `metrics:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_custom_metric.json)

    PATCH /api/custom-metrics/{id}

  • Write

    Update Mapped Metric

    Update the mapped metric with the given ID. *Rate limits*: Burst: `1/s` Steady: `15/m` Daily: `30/d` **Scopes:** `metrics:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_mapped_metric.json)

    PATCH /api/mapped-metrics/{id}

  • Destructive

    Delete Custom Metric

    Delete a custom metric with the given custom metric ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `metrics:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_custom_metric.json)

    DELETE /api/custom-metrics/{id}

Profiles

  • Read

    Get Profiles

    Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp` Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. *Rate limits*: Burst: `75/s` Steady: `750/m` Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request: Burst: `10/s` Steady: `150/m` To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles.json)

    GET /api/profiles

  • Read

    Get Profile

    Get the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. *Rate limits*: Burst: `75/s` Steady: `750/m` Rate limits when using the `include=list` parameter in your API request: Burst: `1/s` Steady: `15/m` Rate limits when using the `include=segment` parameter in your API request: Burst: `1/s` Steady: `15/m` To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile.json)

    GET /api/profiles/{id}

  • Read

    Get Bulk Import Profiles Jobs

    Get all bulk profile import jobs. Returns a maximum of 100 jobs per request. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_jobs.json)

    GET /api/profile-bulk-import-jobs

  • Read

    Get Bulk Import Profiles Job

    Get a bulk profile import job with the given job ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_job.json)

    GET /api/profile-bulk-import-jobs/{job_id}

  • Read

    Get Bulk Suppress Profiles Jobs

    Get the status of all bulk profile suppression jobs. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `subscriptions:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_jobs.json)

    GET /api/profile-suppression-bulk-create-jobs

  • Read

    Get Bulk Suppress Profiles Job

    Get the bulk suppress profiles job with the given job ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `subscriptions:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_job.json)

    GET /api/profile-suppression-bulk-create-jobs/{job_id}

  • Read

    Get Bulk Unsuppress Profiles Jobs

    Get all bulk unsuppress profiles jobs. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `subscriptions:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_jobs.json)

    GET /api/profile-suppression-bulk-delete-jobs

  • Read

    Get Bulk Unsuppress Profiles Job

    Get the bulk unsuppress profiles job with the given job ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `subscriptions:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_job.json)

    GET /api/profile-suppression-bulk-delete-jobs/{job_id}

  • Read

    Get Push Tokens

    Return push tokens associated with company. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens.json)

    GET /api/push-tokens

  • Read

    Get Push Token

    Return a specific push token based on its ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token.json)

    GET /api/push-tokens/{id}

  • Read

    Get Push Tokens for Profile

    Return all push tokens that belong to the given profile. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens_for_profile.json)

    GET /api/profiles/{id}/push-tokens

  • Read

    Get Push Token IDs for Profile

    Return the IDs of all push tokens associated with the given profile. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token_ids_for_profile.json)

    GET /api/profiles/{id}/relationships/push-tokens

  • Read

    Get Lists for Profile

    Get list memberships for a profile with the given profile ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_lists_for_profile.json)

    GET /api/profiles/{id}/lists

  • Read

    Get List IDs for Profile

    Get list memberships for a profile with the given profile ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_profile.json)

    GET /api/profiles/{id}/relationships/lists

  • Read

    Get Segments for Profile

    Get segment memberships for a profile with the given profile ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `profiles:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments_for_profile.json)

    GET /api/profiles/{id}/segments

  • Read

    Get Segment IDs for Profile

    Get segment membership relationships for a profile with the given profile ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `profiles:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment_ids_for_profile.json)

    GET /api/profiles/{id}/relationships/segments

  • Read

    Get Conversation for Profile

    Get the conversation for a profile with the given profile ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `conversations:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_for_profile.json)

    GET /api/profiles/{id}/conversation

  • Read

    Get Conversation ID for Profile

    Get the conversation relationship for a profile with the given profile ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `conversations:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_id_for_profile.json)

    GET /api/profiles/{id}/relationships/conversation

  • Read

    Get Conversations for Profile

    Get all conversations for a profile with the given profile ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `conversations:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversations_for_profile.json)

    GET /api/profiles/{id}/conversations

  • Read

    Get Conversation IDs for Profile

    Get the IDs of all conversations for a profile across all channels. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `conversations:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_ids_for_profile.json)

    GET /api/profiles/{id}/relationships/conversations

  • Read

    Get List for Bulk Import Profiles Job

    Get list for the bulk profile import job with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_for_bulk_import_profiles_job.json)

    GET /api/profile-bulk-import-jobs/{id}/lists

  • Read

    Get List IDs for Bulk Import Profiles Job

    Get list relationship for the bulk profile import job with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_bulk_import_profiles_job.json)

    GET /api/profile-bulk-import-jobs/{id}/relationships/lists

  • Read

    Get Profiles for Bulk Import Profiles Job

    Get profiles for the bulk profile import job with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_bulk_import_profiles_job.json)

    GET /api/profile-bulk-import-jobs/{id}/profiles

  • Read

    Get Profile IDs for Bulk Import Profiles Job

    Get profile relationships for the bulk profile import job with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_bulk_import_profiles_job.json)

    GET /api/profile-bulk-import-jobs/{id}/relationships/profiles

  • Read

    Get Errors for Bulk Import Profiles Job

    Get import errors for the bulk profile import job with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_errors_for_bulk_import_profiles_job.json)

    GET /api/profile-bulk-import-jobs/{id}/import-errors

  • Read

    Get Profile for Push Token

    Return the profile associated with the given push token. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_for_push_token.json)

    GET /api/push-tokens/{id}/profile

  • Read

    Get Profile ID for Push Token

    Return the ID of the profile associated with the given push token. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_id_for_push_token.json)

    GET /api/push-tokens/{id}/relationships/profile

  • Write

    Create Profile

    Create a new profile. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. The maximum allowed payload size is 100KB. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_profile.json)

    POST /api/profiles

  • Write

    Update Profile

    Update the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged. The maximum allowed payload size is 100KB. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_profile.json)

    PATCH /api/profiles/{id}

  • Write

    Bulk Import Profiles

    Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. The maximum allowed payload size per-profile is 100KB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api). *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `lists:write` `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_import_profiles.json)

    POST /api/profile-bulk-import-jobs

  • Write

    Bulk Suppress Profiles

    Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100 *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `profiles:write` `subscriptions:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_suppress_profiles.json)

    POST /api/profile-suppression-bulk-create-jobs

  • Write

    Bulk Unsuppress Profiles

    Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list. This only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100 *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `subscriptions:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsuppress_profiles.json)

    POST /api/profile-suppression-bulk-delete-jobs

  • Write

    Create or Update Push Token

    Create or update a push token. This endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) to create push tokens from users' devices. The maximum allowed payload size is 100KB. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `profiles:write` `push-tokens:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_push_token.json)

    POST /api/push-tokens

  • Write

    Create or Update Profile

    Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged. The maximum allowed payload size is 100KB. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_or_update_profile.json)

    POST /api/profile-import

  • Write

    Bulk Subscribe Profiles

    Subscribe one or more profiles to email marketing, SMS marketing, WhatsApp, or push. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 1000 This endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated "Added to list" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past. Push tokens provided in `push_tokens` will be registered for each profile as long as push subscriptions are consented to. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_subscribe_profiles.json)

    POST /api/profile-subscription-bulk-create-jobs

  • Destructive

    Delete Push Token

    Delete a specific push token based on its ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `push-tokens:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_push_token.json)

    DELETE /api/push-tokens/{id}

  • Destructive

    Merge Profiles

    Merge a given related profile into a profile with the given profile ID. The profile provided under `relationships` (the "source" profile) will be merged into the profile provided by the ID in the base data object (the "destination" profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile. To learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3). *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/merge_profiles.json)

    POST /api/profile-merge

  • Destructive

    Bulk Unsubscribe Profiles

    > 🚧 > > Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes. Unsubscribe one or more profiles from email marketing, SMS marketing, push marketing, or a combination. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Push tokens provided in `subscriptions.push.tokens` will be removed for the specified profiles. To remove someone from a list without changing their subscription status, use [Remove Profiles from List](https://developers.klaviyo.com/en/reference/remove_profiles_from_list). Maximum number of profiles per call: 100 *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsubscribe_profiles.json)

    POST /api/profile-subscription-bulk-delete-jobs

Reporting

  • Read

    Query Campaign Values

    Returns the requested campaign analytics values data *Rate limits*: Burst: `1/s` Steady: `2/m` Daily: `225/d` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_campaign_values.json)

    POST /api/campaign-values-reports

  • Read

    Query Flow Values

    Returns the requested flow analytics values data *Rate limits*: Burst: `1/s` Steady: `2/m` Daily: `225/d` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_flow_values.json)

    POST /api/flow-values-reports

  • Read

    Query Flow Series

    Returns the requested flow analytics series data *Rate limits*: Burst: `1/s` Steady: `2/m` Daily: `225/d` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_flow_series.json)

    POST /api/flow-series-reports

  • Read

    Query Form Values

    Returns the requested form analytics values data. *Rate limits*: Burst: `1/s` Steady: `2/m` Daily: `225/d` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_form_values.json)

    POST /api/form-values-reports

  • Read

    Query Form Series

    Returns the requested form analytics series data. *Rate limits*: Burst: `1/s` Steady: `2/m` Daily: `225/d` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_form_series.json)

    POST /api/form-series-reports

  • Read

    Query Segment Values

    Returns the requested segment analytics values data. *Rate limits*: Burst: `1/s` Steady: `2/m` Daily: `225/d` **Scopes:** `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_segment_values.json)

    POST /api/segment-values-reports

  • Read

    Query Segment Series

    Returns the requested segment analytics series data. *Rate limits*: Burst: `1/s` Steady: `2/m` Daily: `225/d` **Scopes:** `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_segment_series.json)

    POST /api/segment-series-reports

Reviews

  • Read

    Get Reviews

    Get all reviews. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `reviews:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_reviews.json)

    GET /api/reviews

  • Read

    Get Review

    Get the review with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `reviews:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_review.json)

    GET /api/reviews/{id}

  • Write

    Update Review

    Update a review. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `reviews:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_review.json)

    PATCH /api/reviews/{id}

Segments

  • Read

    Get Segments

    Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments.json)

    GET /api/segments

  • Read

    Get Segment

    Get a segment with the given segment ID. *Rate limits*: Burst: `75/s` Steady: `750/m` Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request: Burst: `1/s` Steady: `15/m` To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment.json)

    GET /api/segments/{id}

  • Read

    Get Tags for Segment

    Return all tags associated with the given segment ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `segments:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_segment.json)

    GET /api/segments/{id}/tags

  • Read

    Get Tag IDs for Segment

    If `related_resource` is `tags`, returns the tag IDs of all tags associated with the given segment ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `segments:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_segment.json)

    GET /api/segments/{id}/relationships/tags

  • Read

    Get Profiles for Segment

    Get all profiles within a segment with the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at` *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `profiles:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_segment.json)

    GET /api/segments/{id}/profiles

  • Read

    Get Profile IDs for Segment

    Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `profiles:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_segment.json)

    GET /api/segments/{id}/relationships/profiles

  • Read

    Get Flows Triggered by Segment

    Get all flows where the given segment ID is being used as the trigger. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_segment.json)

    GET /api/segments/{id}/flow-triggers

  • Read

    Get IDs for Flows Triggered by Segment

    Get the IDs of all flows where the given segment is being used as the trigger. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_segment.json)

    GET /api/segments/{id}/relationships/flow-triggers

  • Write

    Create Segment

    Create a segment. *Rate limits*: Burst: `1/s` Steady: `15/m` Daily: `100/d` **Scopes:** `segments:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_segment.json)

    POST /api/segments

  • Write

    Update Segment

    Update a segment with the given segment ID. *Rate limits*: Burst: `1/s` Steady: `15/m` Daily: `100/d` **Scopes:** `segments:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_segment.json)

    PATCH /api/segments/{id}

  • Destructive

    Delete Segment

    Delete a segment with the given segment ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `segments:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_segment.json)

    DELETE /api/segments/{id}

Tags

  • Read

    Get Tags

    List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination). *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags.json)

    GET /api/tags

  • Read

    Get Tag

    Retrieve the tag with the given tag ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag.json)

    GET /api/tags/{id}

  • Read

    Get Tag Groups

    List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination). *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_groups.json)

    GET /api/tag-groups

  • Read

    Get Tag Group

    Retrieve the tag group with the given tag group ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group.json)

    GET /api/tag-groups/{id}

  • Read

    Get Flow IDs for Tag

    Returns the IDs of all flows associated with the given tag. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_ids_for_tag.json)

    GET /api/tags/{id}/relationships/flows

  • Read

    Get Campaign IDs for Tag

    Returns the IDs of all campaigns associated with the given tag. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `campaigns:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_ids_for_tag.json)

    GET /api/tags/{id}/relationships/campaigns

  • Read

    Get List IDs for Tag

    Returns the IDs of all lists associated with the given tag. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `lists:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_tag.json)

    GET /api/tags/{id}/relationships/lists

  • Read

    Get Segment IDs for Tag

    Returns the IDs of all segments associated with the given tag. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `segments:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment_ids_for_tag.json)

    GET /api/tags/{id}/relationships/segments

  • Read

    Get Tag Group for Tag

    Returns the tag group resource for a given tag ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group_for_tag.json)

    GET /api/tags/{id}/tag-group

  • Read

    Get Tag Group ID for Tag

    Returns the id of the tag group related to the given tag. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group_id_for_tag.json)

    GET /api/tags/{id}/relationships/tag-group

  • Read

    Get Tags for Tag Group

    Return the tags for a given tag group ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_tag_group.json)

    GET /api/tag-groups/{id}/tags

  • Read

    Get Tag IDs for Tag Group

    Returns the tag IDs of all tags inside the given tag group. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_tag_group.json)

    GET /api/tag-groups/{id}/relationships/tags

  • Write

    Create Tag

    Create a tag. An account cannot have more than **500** unique tags. A tag belongs to a single tag group. If `relationships.tag-group.data.id` is not specified, the tag is added to the account's default tag group. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_tag.json)

    POST /api/tags

  • Write

    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. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tag.json)

    PATCH /api/tags/{id}

  • Write

    Create Tag Group

    Create a tag group. An account cannot have more than **50** unique tag groups. If `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_tag_group.json)

    POST /api/tag-groups

  • Write

    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. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tag_group.json)

    PATCH /api/tag-groups/{id}

  • Write

    Tag Flows

    Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_flows.json)

    POST /api/tags/{id}/relationships/flows

  • Write

    Tag Campaigns

    Associate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `campaigns:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_campaigns.json)

    POST /api/tags/{id}/relationships/campaigns

  • Write

    Tag Lists

    Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `lists:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_lists.json)

    POST /api/tags/{id}/relationships/lists

  • Write

    Tag Segments

    Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `segments:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_segments.json)

    POST /api/tags/{id}/relationships/segments

  • Destructive

    Delete Tag

    Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_tag.json)

    DELETE /api/tags/{id}

  • Destructive

    Delete Tag Group

    Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_tag_group.json)

    DELETE /api/tag-groups/{id}

  • Destructive

    Remove Tag from 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. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `flows:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_flows.json)

    DELETE /api/tags/{id}/relationships/flows

  • Destructive

    Remove Tag from Campaigns

    Remove a tag's association with one or more campaigns. Use the request body to pass in the ID(s) of the campaign(s) whose association with the tag will be removed. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `campaigns:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_campaigns.json)

    DELETE /api/tags/{id}/relationships/campaigns

  • Destructive

    Remove Tag from 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. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `lists:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_lists.json)

    DELETE /api/tags/{id}/relationships/lists

  • Destructive

    Remove Tag from Segments

    Remove a tag's association with one or more segments. Use the request body to pass in the ID(s) of the segments(s) whose association with the tag will be removed. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `segments:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_segments.json)

    DELETE /api/tags/{id}/relationships/segments

Templates

  • Read

    Get Templates

    Get all templates in an account. Use `additional-fields[template]=definition` to include the full template definition for SYSTEM_DRAGGABLE templates. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `templates:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_templates.json)

    GET /api/templates

  • Read

    Get Template

    Get a template with the given template ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `templates:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template.json)

    GET /api/templates/{id}

  • Read

    Get All Universal Content

    Get all universal content in an account. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `templates:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_all_universal_content.json)

    GET /api/template-universal-content

  • Read

    Get Universal Content

    Get the universal content with the given ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `templates:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_universal_content.json)

    GET /api/template-universal-content/{id}

  • Read

    Get Template Conversion Jobs

    Get the template conversion jobs created in the last 7 days, newest first. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `templates:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_conversion_jobs.json)

    GET /api/template-conversion-jobs

  • Read

    Get Template Conversion Job

    Get a template conversion job with the given job ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `templates:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_conversion_job.json)

    GET /api/template-conversion-jobs/{id}

  • Read

    Render Template

    Render a template with the given template ID and context attribute. Returns the AMP, HTML, and plain text versions of the email template. **Request body parameters** (nested under `attributes`): * `return_fields`: Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets). * `context`: This is the context your email template will be rendered with. You must pass in a `context` object as a JSON object. Email templates are rendered with contexts in a similar manner to Django templates. Nested template variables can be referenced via dot notation. Template variables without corresponding `context` values are treated as `FALSE` and output nothing. Ex. `{ "name" : "George Washington", "state" : "VA" }` *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `templates:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/render_template.json)

    POST /api/template-render

  • Write

    Create Template

    Create a new HTML or drag-and-drop template. If there are 1,000 or more templates in an account, creation will fail as there is a limit of 1,000 templates that can be created via the API. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets). *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `templates:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_template.json)

    POST /api/templates

  • Write

    Update Template

    Update a template with the given template ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `templates:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_template.json)

    PATCH /api/templates/{id}

  • Write

    Create Universal Content

    Create universal content. Supports every block type (including Coupon, Review, Video, Header, Product, Social, Split, and Table) as well as Section content. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `templates:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_universal_content.json)

    POST /api/template-universal-content

  • Write

    Update Universal Content

    Update universal content. The `definition` field always replaces the entire content definition (no attribute-level merge); omit it for a rename-only update. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `templates:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_universal_content.json)

    PATCH /api/template-universal-content/{id}

  • Write

    Create Template Conversion Job

    Convert an HTML template into a new drag-and-drop template. The job runs asynchronously. Poll the job until its status is `complete` or `failed`. When complete, `converted-template` is the new template. Rate limited to 1 request per minute. Requires an account on a paid plan; other accounts get a 403. *Rate limits*: Burst: `1/s` Steady: `1/m` **Scopes:** `templates:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_template_conversion_job.json)

    POST /api/template-conversion-jobs

  • Write

    Clone Template

    Create a clone of a template with the given template ID. If there are 1,000 or more templates in an account, cloning will fail as there is a limit of 1,000 templates that can be created via the API. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `templates:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/clone_template.json)

    POST /api/template-clone

  • Write

    Create Template Preview Send Job

    Send a test email of a template to one or more recipients. *Rate limits*: Burst: `1/s` Steady: `15/m` Daily: `100/d` **Scopes:** `templates:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_template_preview_send_job.json)

    POST /api/template-preview-send-jobs

  • Write

    Clone Universal Content

    Create a clone of the universal content with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `templates:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/clone_universal_content.json)

    POST /api/template-universal-content-clone

  • Destructive

    Delete Template

    Delete a template with the given template ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `templates:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_template.json)

    DELETE /api/templates/{id}

  • Destructive

    Delete Universal Content

    Delete the universal content with the given ID. *Rate limits*: Burst: `75/s` Steady: `750/m` **Scopes:** `templates:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_universal_content.json)

    DELETE /api/template-universal-content/{id}

Text Messaging

  • Read

    Get Text Messaging Configuration

    Retrieve the SMS account for the calling company. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_text_messaging_configuration.json)

    GET /api/text-messaging-configurations/{id}

  • Read

    Get Text Messaging Senders

    List the calling company's text-messaging senders. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_text_messaging_senders.json)

    GET /api/text-messaging-senders

  • Read

    Get Text Messaging Sender

    Retrieve a single text-messaging sender by ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_text_messaging_sender.json)

    GET /api/text-messaging-senders/{id}

  • Read

    Get Text Messaging Sender Registration

    Retrieve a sender registration by ID. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_text_messaging_sender_registration.json)

    GET /api/text-messaging-sender-registrations/{id}

  • Read

    Get Messaging Sender Registration for Text Messaging Sender

    Return the most-recent registration for the given sender. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_messaging_sender_registration_for_text_messaging_sender.json)

    GET /api/text-messaging-senders/{id}/text-messaging-sender-registration

  • Read

    Get Messaging Sender Registration ID for Text Messaging Sender

    Return the most-recent registration for the given sender. *Rate limits*: Burst: `3/s` Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_messaging_sender_registration_id_for_text_messaging_sender.json)

    GET /api/text-messaging-senders/{id}/relationships/text-messaging-sender-registration

  • Write

    Create Text Messaging Sender

    Create a sender and submit its initial registration. A toll-free number is provisioned in all supported regions (US + CA), so the response is the sender for the requested country and the sibling-region sender also appears in list/retrieve. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `sender-config:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_text_messaging_sender.json)

    POST /api/text-messaging-senders

  • Write

    Create Text Messaging Configuration

    Create the SMS account for the calling company. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `sender-config:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_text_messaging_configuration.json)

    POST /api/text-messaging-configurations

  • Write

    Create Text Messaging Sender Registration

    Submit a new registration for an existing sender (resubmission). *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `sender-config:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_text_messaging_sender_registration.json)

    POST /api/text-messaging-sender-registrations

Tracking Settings

  • Read

    Get Tracking Settings

    Get all UTM tracking settings in an account. Returns an array with a single tracking setting. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808). *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `tracking-settings:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tracking_settings.json)

    GET /api/tracking-settings

  • Read

    Get Tracking Setting

    Get the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808). *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `tracking-settings:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tracking_setting.json)

    GET /api/tracking-settings/{id}

  • Write

    Update Tracking Setting

    Update the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808). *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `tracking-settings:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tracking_setting.json)

    PATCH /api/tracking-settings/{id}

Translations

  • Read

    Get Translations

    Get all translations in an account. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_translations.json)

    GET /api/translations

  • Read

    Get Translation

    Get the translation with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_translation.json)

    GET /api/translations/{id}

  • Read

    Get Campaign Variation for Translation

    Get the campaign variation for the given translation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_variation_for_translation.json)

    GET /api/translations/{id}/campaign-variation

  • Read

    Get Campaign Variation ID for Translation

    Get the campaign variation for the given translation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_variation_id_for_translation.json)

    GET /api/translations/{id}/relationships/campaign-variation

  • Read

    Get Flow Message for Translation

    Get the flow message for the given translation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `flows:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_message_for_translation.json)

    GET /api/translations/{id}/flow-message

  • Read

    Get Flow Message ID for Translation

    Get the flow message for the given translation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `flows:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_message_id_for_translation.json)

    GET /api/translations/{id}/relationships/flow-message

  • Read

    Get Template for Translation

    Get the template for the given translation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `templates:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_for_translation.json)

    GET /api/translations/{id}/template

  • Read

    Get Template ID for Translation

    Get the template for the given translation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `templates:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_id_for_translation.json)

    GET /api/translations/{id}/relationships/template

  • Read

    Get Template Universal Content for Translation

    Get the template universal content for the given translation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `templates:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_universal_content_for_translation.json)

    GET /api/translations/{id}/template-universal-content

  • Read

    Get Template Universal Content ID for Translation

    Get the template universal content for the given translation ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `templates:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_universal_content_id_for_translation.json)

    GET /api/translations/{id}/relationships/template-universal-content

  • Write

    Create Translation

    Create a translation. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `translations:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_translation.json)

    POST /api/translations

  • Write

    Update Translation

    Update the translation with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `translations:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_translation.json)

    PATCH /api/translations/{id}

  • Destructive

    Delete Translation

    Delete the translation with the given ID. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `translations:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_translation.json)

    DELETE /api/translations/{id}

Web Feeds

  • Read

    Get Web Feeds

    Get all web feeds for an account. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `web-feeds:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feeds.json)

    GET /api/web-feeds

  • Read

    Get Web Feed

    Get the web feed with the given ID. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `web-feeds:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feed.json)

    GET /api/web-feeds/{id}

  • Write

    Create Web Feed

    Create a web feed. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `web-feeds:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_web_feed.json)

    POST /api/web-feeds

  • Write

    Update Web Feed

    Update the web feed with the given ID. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `web-feeds:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_web_feed.json)

    PATCH /api/web-feeds/{id}

  • Destructive

    Delete Web Feed

    Delete the web feed with the given ID. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `web-feeds:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_web_feed.json)

    DELETE /api/web-feeds/{id}

Webhooks

  • Read

    Get Webhooks

    Get all webhooks in an account. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `webhooks:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhooks.json)

    GET /api/webhooks

  • Read

    Get Webhook

    Get the webhook with the given ID. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `webhooks:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook.json)

    GET /api/webhooks/{id}

  • Read

    Get Webhook Topics

    Get all webhook topics in a Klaviyo account. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `webhooks:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook_topics.json)

    GET /api/webhook-topics

  • Read

    Get Webhook Topic

    Get the webhook topic with the given ID. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `webhooks:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook_topic.json)

    GET /api/webhook-topics/{id}

  • Write

    Create Webhook

    Create a new Webhook *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `webhooks:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_webhook.json)

    POST /api/webhooks

  • Write

    Update Webhook

    Update the webhook with the given ID. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `webhooks:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_webhook.json)

    PATCH /api/webhooks/{id}

  • Destructive

    Delete Webhook

    Delete a webhook with the given ID. *Rate limits*: Burst: `1/s` Steady: `15/m` **Scopes:** `webhooks:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_webhook.json)

    DELETE /api/webhooks/{id}

Client

  • Read

    Get Client Review Values Reports

    Get all reviews values reports in an account. *Rate limits*: Burst: `10/s` Steady: `150/m` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_review_values_reports.json)

    GET /client/review-values-reports

  • Read

    Get Client Reviews

    Get all reviews. This endpoint is for client-side environments only, for server-side use, refer to https://developers.klaviyo.com/en/reference/get_reviews *Rate limits*: Burst: `10/s` Steady: `150/m` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_reviews.json)

    GET /client/reviews

  • Read

    Get Client Geofences

    Get all geofences in an account. Returns a paginated list of all geofences for the specified company. This is the GA API endpoint designed for mobile SDK consumption. No authentication required. Returns a maximum of 100 results per page (default 20). This API supports filtering via header instead of query param. Provide `X-Klaviyo-API-Filters` header to filter geofences. We don't use regular query param filters here because lat and long are sensitive information. Supported filters: - `lat` (equals) - Latitude coordinate for distance-based sorting - `lng` (equals) - Longitude coordinate for distance-based sorting When both lat and lng are provided, geofences are returned sorted by distance from the specified coordinates (closest first). Example filter header: `X-Klaviyo-API-Filters: and(equals(lat,40.7128),equals(lng,-74.0060))` *Rate limits*: Burst: `3/s` Steady: `60/m` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_geofences.json)

    GET /client/geofences

  • Read

    Get Client IP Allowlist

    Return the current integration-egress IP allow list. This is a singleton resource addressed at the fixed id ``integration-egress``: call ``GET /client/ip-allowlists/integration-egress`` (not ``GET /client/ip-allowlists``). Any other id returns 404. *Rate limits*: Burst: `75/s` Steady: `750/m` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_ip_allowlist.json)

    GET /client/ip-allowlists/{id}

  • Write

    Create Client Review

    Create a review with the given ID. This endpoint is for client-side environments only. *Rate limits*: Burst: `10/s` Steady: `150/m` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_review.json)

    POST /client/reviews

  • Write

    Create Client Subscription

    Creates a subscription and consent record for email and/or SMS channels based on the provided `email` and `phone_number` attributes, respectively. One of either `email` or `phone_number` must be provided. This endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints. Do not use this endpoint from server-side applications. To subscribe profiles from server-side applications, instead use [POST /api/profile-subscription-bulk-create-jobs](https://developers.klaviyo.com/en/reference/subscribe_profiles). Profiles can be opted into multiple channels: email marketing, SMS marketing, and SMS transactional. You can specify the channel(s) to subscribe the profile to by providing a subscriptions object in the profile attributes. If you include a subscriptions object, only channels in that object will be subscribed. You can use this to update `email` or `phone` on the profile without subscribing them, for example, by setting the profile property but omitting that channel in the subscriptions object. If a subscriptions object is not provided, subscriptions are defaulted to `MARKETING`. *Rate limits*: Burst: `350/s` Steady: `750/m` **Scopes:** `subscriptions:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_subscription.json)

    POST /client/subscriptions

  • Write

    Create or Update Client Push Token

    Create or update a push token. This endpoint is specifically designed to be called from our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints. You must have push notifications enabled to use this endpoint. To migrate push tokens from another platform to Klaviyo, please use our server-side [POST /api/push-tokens](https://developers.klaviyo.com/en/reference/create_push_token) endpoint instead. *Rate limits*: Burst: `150/s` Steady: `1400/m` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_push_token.json)

    POST /client/push-tokens

  • Write

    Create Client Event

    Create a new event to track a profile's activity. This endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints. Do not use this endpoint from server-side applications. To create events from server-side applications, instead use [POST /api/events](https://developers.klaviyo.com/en/reference/create_event). Note that to update a profile's existing identifiers (e.g., email), you must use a server-side endpoint authenticated by a private API key. Attempts to do so via client-side endpoints will return a 202, however the identifier field(s) will not be updated. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `events:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_event.json)

    POST /client/events

  • Write

    Create or Update Client Profile

    Create or update properties about a profile without tracking an associated event. This endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints. Do not use this endpoint from server-side applications. To create or update profiles from server-side applications, instead use [POST /api/profile-import](https://developers.klaviyo.com/en/reference/create_or_update_profile). Note that to update a profile's existing identifiers (e.g., email), you must use a server-side endpoint authenticated by a private API key. Attempts to do so via client-side endpoints will return a 202, however the identifier field(s) will not be updated. *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_profile.json)

    POST /client/profiles

  • Write

    Bulk Create Client Events

    Create new events to track a profile's activity. This endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints. Do not use this endpoint from server-side applications. To create events from server-side applications, instead use [POST /api/event-bulk-create-jobs](https://developers.klaviyo.com/en/reference/bulk_create_events). Accepts a maximum of `1000` events per request. *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `events:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_client_events.json)

    POST /client/event-bulk-create

  • Write

    Create Client Back In Stock Subscription

    Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details. This endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints. Do not use this endpoint from server-side applications. To create back in stock subscriptions from server-side applications, instead use [POST /api/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_back_in_stock_subscription). *Rate limits*: Burst: `350/s` Steady: `3500/m` **Scopes:** `catalogs:write` `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_back_in_stock_subscription.json)

    POST /client/back-in-stock-subscriptions

  • Destructive

    Unregister Client Push Token

    Unregister a push token. This endpoint is specifically designed to be called from our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints. You must have push notifications enabled to use this endpoint. *Rate limits*: Burst: `10/s` Steady: `150/m` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/unregister_client_push_token.json)

    POST /client/push-token-unregister

Get started

  1. Open Space settings → Connections and search for Klaviyo.
  2. Connect your account and add the connection to the Space.
  3. Ask for what you need in any thread in that Space.

See How connections work for access and permissions, or browse all integrations.