Get a form with its definition
https://email.growthdept.ai/api/forms/{id}Rate limits
Scopes
forms:read
Operation id
get_form The same operation as in Klaviyo's API. OpenAPI document
Path parameters
stringrequired
Query parameters
Pick values to add them to the request:
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
200Success
Response body
object
dataobjectrequired
data: 4 fields
typestringrequired
formidstringrequired
attributesobjectrequired
attributes: 6 fields
statusstringrequired
draftliveab_testbooleanrequired
namestringrequired
definitionobjectrequired
definition: 1 field
versionsarray of objectsrequired
versions: 15 fields
idintegercan be null
stepsarray of objectsrequired
steps: 5 fields
idstringcan be null
temporary_idstringcan be null
columnsarray of objectsrequired
columns: 3 fields
idstringcan be null
rowsarray of objects
stylesobjectcan be null
namestringcan be null
stepsarray of objectscan be null
steps: 5 fields
idstringcan be null
temporary_idstringcan be null
columnsarray of objectsrequired
namestringcan be null
stepsarray of objectscan be null
triggersarray of objects
One option: AfterCloseTimeout
idstringcan be null
typestringrequired
after_close_or_submit_timeoutpropertiesobject
properties: 1 field
timeout_daysinteger
One option: CartContent
idstringcan be null
typestringrequired
cart_contentpropertiesobject
properties: 3 fields
valueobjectcan be null
itemsobjectcan be null
productobjectcan be null
One option: CartItemCount
idstringcan be null
typestringrequired
cart_item_countpropertiesobject
properties: 2 fields
comparisonstringcan be null
equalsgreater_thanless_thanvalueintegercan be null
One option: CartProduct
idstringcan be null
typestringrequired
cart_productpropertiesobject
properties: 2 fields
typestringcan be null
brandcategoriesidnamevaluestringcan be null
One option: CartValue
idstringcan be null
typestringrequired
cart_valuepropertiesobject
properties: 2 fields
comparisonstringcan be null
equalsgreater_thanless_thanvaluenumbercan be null
One option: Channel
idstringcan be null
typestringrequired
channelpropertiesobjectrequired
properties: 1 field
channelstringrequired
emailsms
One option: CustomJavascript
idstringcan be null
propertiesobject
typestringrequired
custom_javascript
One option: Delay
idstringcan be null
typestringrequired
delaypropertiesobject
properties: 1 field
secondsinteger
One option: Device
idstringcan be null
typestringrequired
devicepropertiesobject
properties: 1 field
devicestring
bothdesktopmobile
One option: ExitIntent
idstringcan be null
propertiesobject
typestringrequired
exit_intent
One option: IdentifiedProfiles
idstringcan be null
propertiesobject
typestringrequired
identified_profiles
One option: ListsAndSegments
idstringcan be null
typestringrequired
lists_and_segmentspropertiesobjectrequired
properties: 2 fields
allow_listarray of stringscan be null
deny_listarray of stringscan be null
One option: Location
idstringcan be null
typestringrequired
locationpropertiesobjectrequired
properties: 2 fields
allow_listarray of objectscan be null
deny_listarray of objectscan be null
One option: PageVisits
idstringcan be null
typestringrequired
page_visitspropertiesobject
properties: 1 field
pagesinteger
One option: PreviouslySubmitted
idstringcan be null
propertiesobject
typestringrequired
previously_submitted
One option: ProfileEventTracked
idstringcan be null
typestringrequired
profile_event_trackedpropertiesobjectrequired
properties: 3 fields
metricstringcan be null
property_filtersarray of objectscan be null
delay_secondsintegercan be null
One option: Scroll
idstringcan be null
typestringrequired
scroll_percentagepropertiesobject
properties: 1 field
percentageinteger
One option: UnidentifiedProfiles
idstringcan be null
propertiesobject
typestringrequired
unidentified_profiles
One option: URLPatterns
idstringcan be null
typestringrequired
url_patternspropertiesobject
properties: 2 fields
allow_listarray of stringscan be null
deny_listarray of stringscan be null
One option: BackInStock
idstringcan be null
typestringrequired
back_in_stockpropertiesobject
properties: 2 fields
tag_allowlistarray of strings
tag_blocklistarray of strings
teasersarray of objects
teasers: 10 fields
idstringcan be null
contentstringrequired
display_orderstring
afterbeforebefore_and_afterteaser_typestring
circlecornerrectanglelocationstring
bottom_centerbottom_leftbottom_rightcenter_leftcenter_righttop_centertop_lefttop_rightsizestring
customlargemediumsmallcustom_sizeintegercan be null
stylesobject
styles: 6 fields
background_colorstring
drop_shadowobject
corner_radiusinteger
background_imageobjectcan be null
close_buttonobject
marginobject
close_buttonboolean
device_typestring
bothdesktopmobile
dynamic_buttonobjectcan be null
dynamic_button: 3 fields
idstringcan be null
typestringrequired
BACK_IN_STOCK_OPENdataobjectrequired
data: 4 fields
labelstring
displaystring
NEXT_TOREPLACEtext_stylesobject
button_stylesobject
namestringcan be null
stylesobject
styles: 17 fields
wrap_contentboolean
falseborder_stylesobjectcan be null
border_styles: 4 fields
radiusinteger
colorstringcan be null
stylestringcan be null
dasheddottedsolidthicknessintegercan be null
close_buttonobject
close_button: 7 fields
background_colorstring
outline_colorstring
colorstring
strokenumber
sizeinteger
marginobject
positionstringcan be null
leftright
marginobject
margin: 4 fields
leftinteger
rightinteger
topinteger
bottominteger
paddingobject
padding: 4 fields
leftinteger
rightinteger
topinteger
bottominteger
minimum_heightinteger
widthstring
customfulllargemediumsmallcustom_widthintegercan be null
background_imageobjectcan be null
background_image: 2 fields
stylesobject
propertiesobjectrequired
background_colorstringcan be null
input_stylesobject
input_styles: 10 fields
text_stylesobject
label_colorstring
text_colorstring
placeholder_colorstring
background_colorstring
border_colorstring
border_focus_colorstring
focus_outline_colorstring
corner_radiusinteger
field_heightinteger
drop_shadowobject
drop_shadow: 3 fields
enabledboolean
blurinteger
colorstringcan be null
overlay_colorstring
rich_text_stylesobject
rich_text_styles: 8 fields
bodyobject
linkobject
h1object
h2object
h3object
h4object
h5object
h6object
mobile_overlayobjectcan be null
mobile_overlay: 2 fields
colorstringcan be null
enabledboolean
false
banner_stylesobjectcan be null
banner_styles: 3 fields
desktop_positionstring
bottomtopmobile_positionstring
bottomtopscroll_with_pageboolean
custom_cssobject
custom_css: 2 fields
enabledboolean
cssstring
propertiesobject
properties: 6 fields
side_image_settingsobjectcan be null
side_image_settings: 3 fields
sizestring
largemediumsmallalignmentstring
leftrightdevice_typearray of strings
click_outside_to_closearray of stringscan be null
rule_based_trigger_evaluationstringcan be null
allanyrecord_utm_params_on_submitboolean
show_close_buttonboolean
accessible_namestringcan be null
typestring
bannerembedflyoutfull_screenpopuplocationstringcan be null
bottom_centerbottom_leftbottom_rightcenter_leftcenter_righttop_centertop_lefttop_rightstatusstring
draftliveab_testboolean
specialtiesarray of strings
channelstring
IN_APPWEBmessage_priorityinteger
created_atstring (date-time)required
updated_atstring (date-time)required
linksobjectrequired
links: 1 field
selfstring (uri)required
linksobject
links: 1 field
selfstring (uri)required
metaobject
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject