Klaviyo Forms API is one of 23 APIs that Klaviyo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Forms. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, an API reference, authentication docs, and rate-limit docs.
This API exposes 9 operations across 7 paths, and defines 186 schemas. It is described by OpenAPI 3.0.2, at version 2026-04-15.
Requests are made against a single base URL, https://a.klaviyo.com.
9 operations
7 paths
186 schemas
1 DELETE7 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Klaviyo Forms API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (Klaviyo-API-Key).
By default, every request must be authenticated.
Klaviyo-API-Key— Private key authentication for /api/ endpoints is performed by setting the Authorization header to Klaviyo-API-Key your-private-api-key For more information pl…
Paths & Operations 9
Across 7 paths, the API surfaces 9 operations — 1 DELETE, 7 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Forms 9
forms
GET
/api/forms
Get Forms
POST
/api/forms
Create Form
GET
/api/forms/{id}
Get Form
DELETE
/api/forms/{id}
Delete Form
GET
/api/form-versions/{id}
Get Form Version
GET
/api/forms/{id}/form-versions
Get Versions for Form
GET
/api/forms/{id}/relationships/form-versions
Get Version IDs for Form
GET
/api/form-versions/{id}/form
Get Form for Form Version
GET
/api/form-versions/{id}/relationships/form
Get Form ID for Form Version
Schemas 186
The contract defines 186 schemas that model the data the API accepts and returns. The most detailed are VersionStyles (17 properties), Version (13 properties), ButtonStyles (11 properties), AgeGateProperties (10 properties). Each schema is shown below with its type and property counts.
SideImageSettings
object
3 properties
BackInStock
object
3 properties
1 required
SubmitBackInStock
object
4 properties
1 required
ImageProperties
object
4 properties
1 required
Channel
object
3 properties
2 required
Redirect
object
4 properties
3 required
SubscribeViaWhatsApp
object
4 properties
2 required
CloseProperties
object
1 property
SubscribeViaWhatsAppProperties
object
3 properties
3 required
UniqueCouponConfig
object
5 properties
1 required
HTMLTextProperties
object
3 properties
BackInStockEmailConsentCheckboxProperties
object
9 properties
1 required
RatingStyle
object
6 properties
RedirectProperties
object
3 properties
1 required
TextProperties
object
8 properties
1 required
DelayProperties
object
1 property
OptInCodeStyles
object
2 properties
FormVersionEnum
string
CouponProperties
object
4 properties
1 required
QuoteStyle
object
7 properties
LinkStyles
object
2 properties
ReviewStyles
object
6 properties
ListsAndSegmentsProperties
object
2 properties
OptInCode
object
4 properties
2 required
SpinToWinSliceStyle
object
2 properties
BackInStockEmailConsentCheckboxStyles
object
3 properties
PhoneNumberStyles
object
2 properties
Padding
object
4 properties
AgeGate
object
5 properties
2 required
SubmitOptInCode
object
4 properties
1 required
SMSDisclosureProperties
object
3 properties
SMSDisclosureStyles
object
4 properties
FormCreateQuery
object
1 property
1 required
PropertyOption
object
2 properties
2 required
SkipToSuccess
object
4 properties
2 required
RadioButtons
object
4 properties
2 required
ObjectLinks
object
1 property
1 required
CheckboxesStyles
object
4 properties
CartProductProperties
object
2 properties
Step
object
4 properties
1 required
EncodedFormResponseObjectResource
object
4 properties
4 required
CloseButtonStyle
object
6 properties
StaticCouponConfig
object
2 properties
1 required
DropdownStyles
object
2 properties
SpinToWinStyles
object
9 properties
Delay
object
3 properties
1 required
CustomCss
object
2 properties
ReviewerNameStyle
object
8 properties
Location
object
3 properties
2 required
VersionStyles
object
17 properties
OpenForm
object
4 properties
2 required
GetFormVersionsRelationshipsResponseCollection
object
2 properties
1 required
DropShadow
object
3 properties
GetFormVersionResponse
object
2 properties
1 required
NextStep
object
4 properties
2 required
FormResponseObjectResource
object
5 properties
4 required
Version
object
13 properties
1 required
FixedTimerConfiguration
object
3 properties
2 required
DateProperties
object
9 properties
1 required
TriggerBaseProperties
object
FormVersionABTest
object
1 property
1 required
IdentifiedProfiles
object
3 properties
1 required
ErrorMessages
object
2 properties
BackInStockDynamicButtonTextStyles
object
7 properties
Text
object
4 properties
2 required
SpinToWinSliceConfig
object
3 properties
3 required
RichTextStyle
object
10 properties
AgeGateProperties
object
10 properties
BackInStockDynamicButtonStyles
object
7 properties
SubscribeViaSMS
object
4 properties
2 required
SMSDisclosureTextStyle
object
7 properties
TeaserStyles
object
6 properties
SpinToWin
object
4 properties
2 required
CartProduct
object
3 properties
1 required
Image
object
5 properties
2 required
ButtonStyles
object
11 properties
ImageAssetProperties
object
5 properties
Checkboxes
object
4 properties
2 required
URLPatterns
object
3 properties
1 required
GetFormVersionResponseCollection
object
2 properties
1 required
RelationshipLinks
object
2 properties
2 required
ImageDropShadowStyles
object
5 properties
PhoneNumber
object
4 properties
2 required
HTMLText
object
4 properties
1 required
Scroll
object
3 properties
1 required
VariableTimerConfiguration
object
4 properties
4 required
TextStyles
object
2 properties
BorderStyle
object
4 properties
RadioButtonsStyles
object
4 properties
ExitIntent
object
3 properties
1 required
RichTextMargin
object
4 properties
SignupCounter
object
4 properties
2 required
EmailProperties
object
8 properties
BackInStockDynamicButtonDropShadowStyles
object
5 properties
URLPatternsProperties
object
2 properties
BackInStockDynamicButtonBorderStyles
object
4 properties
ResendOptInCode
object
4 properties
1 required
CartItemCountProperties
object
2 properties
SMSConsentCheckboxStyles
object
3 properties
GetFormResponseCollection
object
2 properties
1 required
CartItemCount
object
3 properties
1 required
ProfileEventTracked
object
3 properties
2 required
AdditionalField
object
2 properties
2 required
NextStepProperties
object
1 property
FormVersionResponseObjectResource
object
4 properties
4 required
TextStyleV0
object
7 properties
AgeGateStyles
object
2 properties
MobileOverlay
object
2 properties
GetEncodedFormResponse
object
2 properties
1 required
CartValue
object
3 properties
1 required
CouponStyles
object
5 properties
RowV0
object
2 properties
1 required
AfterCloseTimeoutProperties
object
1 property
DateStyles
object
2 properties
ButtonProperties
object
4 properties
1 required
VersionProperties
object
5 properties
PreviouslySubmitted
object
3 properties
1 required
RichTextStyles
object
8 properties
HTMLTextStyles
object
2 properties
ChannelSettings
object
2 properties
PageVisitsProperties
object
1 property
OpenFormProperties
object
2 properties
1 required
AfterCloseTimeout
object
3 properties
1 required
PromotionalSMSSubscription
object
4 properties
1 required
BackgroundImageStyles
object
5 properties
OptInCodeProperties
object
8 properties
ButtonDropShadowStyles
object
5 properties
CountdownTimer
object
4 properties
2 required
SMSDisclosureCustom
object
5 properties
1 required
Teaser
object
10 properties
1 required
DeviceProperties
object
1 property
CountdownTimerStyles
object
6 properties
SpinToWinProperties
object
4 properties
1 required
LocationProperties
object
2 properties
PhoneNumberConsentChannelSettings
object
1 property
BannerStyles
object
3 properties
SubmitBackInStockProperties
object
1 property
BackInStockDynamicButtonData
object
4 properties
FormCreateQueryResourceObject
object
2 properties
2 required
ScrollProperties
object
1 property
Date
object
4 properties
2 required
GoToInbox
object
4 properties
1 required
SignupCounterStyles
object
2 properties
SMSConsentCheckboxProperties
object
10 properties
1 required
PageVisits
object
3 properties
1 required
Button
object
5 properties
2 required
SubscribeViaSMSProperties
object
3 properties
3 required
DropdownProperties
object
9 properties
2 required
ListsAndSegments
object
3 properties
2 required
InputStyles
object
10 properties
ColumnV0
object
3 properties
BackgroundImage
object
2 properties
1 required
SMSDisclosure
object
4 properties
1 required
ColumnStyles
object
2 properties
Device
object
3 properties
1 required
ImageStyles
object
5 properties
CountdownTimerProperties
object
5 properties
1 required
Coupon
object
4 properties
2 required
RadioButtonsProperties
object
9 properties
2 required
UnidentifiedProfiles
object
3 properties
1 required
SignupCounterProperties
object
5 properties
3 required
GetFormVersionFormRelationshipResponse
object
2 properties
1 required
PhoneNumberProperties
object
10 properties
EmailStyles
object
2 properties
Dropdown
object
4 properties
2 required
Close
object
4 properties
2 required
DynamicButton
object
3 properties
2 required
FormDefinition
object
1 property
1 required
SkipToSuccessProperties
object
Email
object
4 properties
2 required
FormEnum
string
ProfileEventTrackedProperties
object
1 property
1 required
CustomJavascript
object
3 properties
1 required
Margin
object
4 properties
BackInStockProperties
object
2 properties
Review
object
4 properties
2 required
SMSConsentCheckbox
object
4 properties
2 required
PostEncodedFormResponse
object
2 properties
1 required
ChannelProperties
object
1 property
1 required
CheckboxesProperties
object
9 properties
2 required
CollectionLinks
object
5 properties
1 required
CartValueProperties
object
2 properties
BackInStockEmailConsentCheckbox
object
4 properties
2 required
ReviewProperties
object
10 properties
SMSDisclosureAccountDefault
object
2 properties
1 required
GetFormResponse
object
2 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Klaviyo 12
Other APIs Klaviyo publishes across the network.
Klaviyo Accounts API
Klaviyo Campaigns API
Klaviyo Catalogs API
Klaviyo Client API
Klaviyo Conversations API
Klaviyo Coupons API
Klaviyo Custom Objects API
Klaviyo Data Privacy API
Klaviyo Events API
Klaviyo Flows API
Klaviyo Images API
Klaviyo Lists API
#Forms