# 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 definition
```json
{
"openapi": "3.0.2",
"info": {
"title": "Forms API",
"version": "2024-10-15",
"description": "The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.",
"contact": {
"name": "Klaviyo Developer Experience Team",
"email": "developers@klaviyo.com",
"url": "https://developers.klaviyo.com"
},
"termsOfService": "https://www.klaviyo.com/legal/api-terms",
"license": {
"name": "License",
"url": "https://www.klaviyo.com/legal"
}
},
"servers": [
{
"url": "https://a.klaviyo.com",
"description": "Production"
}
],
"paths": {
"/api/form-versions/{id}/form": {
"get": {
"operationId": "get_form_for_form_version",
"summary": "Get Form for Form Version",
"description": "Get the form associated with the given form version.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`forms:read`",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the form version",
"required": true,
"schema": {
"description": "The ID of the form version",
"type": "string",
"example": "1234567"
}
},
{
"name": "fields[form]",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"status",
"ab_test",
"created_at",
"updated_at"
]
}
},
"explode": false
},
{
"name": "revision",
"in": "header",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"required": true,
"schema": {
"type": "string",
"default": "2024-10-15"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFormResponse"
}
}
}
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"tags": [
"Forms"
],
"x-klaviyo-operation-aliases": [
"get_form_version_form"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"forms:read"
]
}
}
},
"components": {
"schemas": {
"FormEnum": {
"type": "string",
"enum": [
"form"
]
},
"FormResponseObjectResource": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/FormEnum"
},
"id": {
"description": "ID of the form. Generated by Klaviyo.",
"type": "string",
"example": "Y6nRLr"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"description": "Name of the form.",
"type": "string",
"example": "Cyber Monday Deals"
},
"status": {
"description": "Status of the form. A live form with an in-progress draft is considered \"live\".",
"type": "string",
"enum": [
"draft",
"live"
]
},
"ab_test": {
"description": "Whether the form has an A/B test configured, regardless of its status.",
"type": "boolean"
},
"created_at": {
"description": "ISO8601 timestamp when the form was created.",
"type": "string",
"format": "date-time",
"example": "2024-03-04T00:00:00Z"
},
"updated_at": {
"description": "ISO8601 timestamp when the form was last updated.",
"type": "string",
"format": "date-time",
"example": "2024-03-04T00:00:00Z"
}
},
"required": [
"name",
"status",
"ab_test",
"created_at",
"updated_at"
]
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"GetFormResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/FormResponseObjectResource"
},
{
"properties": {
"relationships": {
"type": "object",
"properties": {
"form-versions": {
"type": "object",
"properties": {
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
}
}
}
}
}
]
}
},
"required": [
"data"
]
},
"RelationshipLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
},
"related": {
"type": "string",
"format": "uri"
}
},
"required": [
"self",
"related"
]
},
"ObjectLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"self"
]
}
},
"responses": {
"ClientError": {
"description": "Client Error",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"code",
"title",
"detail"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"pointer": {
"type": "string"
},
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"errors"
]
}
}
}
},
"ServerError": {
"description": "Server Error",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"code",
"title",
"detail"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"pointer": {
"type": "string"
},
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"errors"
]
}
}
}
}
},
"securitySchemes": {
"Klaviyo-API-Key": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "Private key authentication for /api/ endpoints is performed by setting the `Authorization` header to `Klaviyo-API-Key your-private-api-key`
For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#authentication",
"x-default": "Klaviyo-API-Key your-private-api-key"
}
}
},
"tags": [
{
"name": "Forms"
}
],
"security": [
{
"Klaviyo-API-Key": []
}
],
"x-readme": {
"explorer-enabled": false,
"proxy-enabled": true,
"samples-enabled": true
},
"_id": {
"buffer": {
"0": 103,
"1": 14,
"2": 199,
"3": 71,
"4": 109,
"5": 224,
"6": 147,
"7": 0,
"8": 82,
"9": 88,
"10": 175,
"11": 46
}
}
}
```