Create hosted quizzes, forms and surveys, send them, and read the responses.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Optional. Bearer <QuizGen API key> for account tools; without it, create_quiz makes a 72-hour sandbox quiz.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Return the connected account's email, plan, and limits. Call this to verify that QuizGen authorization (OAuth or API key) is active. (Formerly named check_api_key; the old name still works.)
This tool takes no arguments.
Return the connected account's email, plan, and limits. Call this to verify that QuizGen authorization (OAuth or API key) is active. (Formerly named check_api_key; the old name still works.)
No arguments.
{
"type": "object",
"properties": {}
}Create a live, hosted quiz/form/survey and get its shareable URL. Without authorization this creates a temporary sandbox quiz (72 hours, 10 responses) with a secret claim_url to keep it. The definition schema below is the complete quiz format — only the 19 documented question types exist, and unknown fields are rejected.
| Argument | Type | Description |
|---|---|---|
| definition* | object | |
| creator_email | string | Optional, sandbox only: your user's email. They get the claim link by email immediately plus one reminder before the quiz expires — worth asking the user for. Never invent one. |
| idempotency_key | string | Optional. Same key within 24h returns the originally created quiz instead of a duplicate. |
{
"type": "object",
"required": [
"definition"
],
"properties": {
"definition": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"schema_version",
"title",
"sections"
],
"properties": {
"kind": {
"enum": [
"quiz",
"survey",
"form",
"email_capture",
"registration"
],
"type": "string"
},
"cover": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 300
},
"subtitle": {
"type": "string",
"maxLength": 1000
},
"image_url": {
"type": "string",
"format": "uri"
},
"button_label": {
"type": "string",
"maxLength": 60
}
},
"additionalProperties": false
},
"theme": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mode": {
"enum": [
"light",
"dark",
"auto"
],
"type": "string"
},
"accent": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"preset": {
"enum": [
"warm",
"midnight",
"forest",
"corporate",
"playful",
"mono"
],
"type": "string"
},
"logo_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"title": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"outcomes": {
"anyOf": [
{
"type": "object",
"required": [
"method",
"points",
"buckets"
],
"properties": {
"method": {
"type": "string",
"const": "points"
},
"points": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"buckets": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"title"
],
"properties": {
"key": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "number"
},
"min": {
"type": "number"
},
"body": {
"type": "string",
"maxLength": 2000
},
"title": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"redirect_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"maxItems": 20,
"minItems": 1
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"questions"
],
"properties": {
"key": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"blurb": {
"type": "string",
"maxLength": 1000
},
"title": {
"type": "string",
"maxLength": 300
},
"questions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "short_text"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"placeholder": {
"type": "string",
"maxLength": 200
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"rows": {
"type": "integer",
"maximum": 20,
"minimum": 2
},
"type": {
"type": "string",
"const": "long_text"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"examples": {
"type": "array",
"items": {
"type": "string",
"maxLength": 300
},
"maxItems": 8
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt",
"options"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "choice"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"label"
],
"properties": {
"label": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"value": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"detail": {
"type": "string",
"maxLength": 500
},
"image_url": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
"maxItems": 20,
"minItems": 2
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"follow_up": {
"type": "string",
"maxLength": 500
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt",
"options"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
"min": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "multi_choice"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"label"
],
"properties": {
"label": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"value": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"detail": {
"type": "string",
"maxLength": 500
},
"image_url": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
"maxItems": 20,
"minItems": 2
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "integer",
"maximum": 10,
"minimum": 2
},
"min": {
"type": "integer",
"maximum": 1,
"minimum": 0
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "scale"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"max_label": {
"type": "string",
"maxLength": 100
},
"min_label": {
"type": "string",
"maxLength": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "email"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"placeholder": {
"type": "string",
"maxLength": 200
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "number"
},
"min": {
"type": "number"
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "number"
},
"unit": {
"type": "string",
"maxLength": 30
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"min": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "date"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "time"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "phone"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"placeholder": {
"type": "string",
"maxLength": 200
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "url"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"placeholder": {
"type": "string",
"maxLength": 200
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "yes_no"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"no_label": {
"type": "string",
"maxLength": 100
},
"required": {
"type": "boolean"
},
"yes_label": {
"type": "string",
"maxLength": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "consent"
},
"terms": {
"type": "object",
"required": [
"title",
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 20000,
"minLength": 1
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"version": {
"type": "string",
"maxLength": 100,
"minLength": 1
}
},
"additionalProperties": false
},
"prompt": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "signature"
},
"terms": {
"type": "object",
"required": [
"title",
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 20000,
"minLength": 1
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"version": {
"type": "string",
"maxLength": 100,
"minLength": 1
}
},
"additionalProperties": false
},
"prompt": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "integer",
"maximum": 10,
"minimum": 2
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "rating"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "number"
},
"min": {
"type": "number"
},
"help": {
"type": "string",
"maxLength": 1000
},
"step": {
"type": "number",
"exclusiveMinimum": 0
},
"type": {
"type": "string",
"const": "slider"
},
"unit": {
"type": "string",
"maxLength": 30
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"max_label": {
"type": "string",
"maxLength": 100
},
"min_label": {
"type": "string",
"maxLength": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "payment"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"currency": {
"type": "string",
"pattern": "^[a-z]{3}$"
},
"required": {
"type": "boolean"
},
"amount_cents": {
"type": "integer",
"maximum": 1000000,
"minimum": 50
},
"button_label": {
"type": "string",
"maxLength": 60
},
"price_options": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"label",
"amount_cents"
],
"properties": {
"label": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"value": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"detail": {
"type": "string",
"maxLength": 500
},
"amount_cents": {
"type": "integer",
"maximum": 1000000,
"minimum": 50
}
},
"additionalProperties": false
},
"maxItems": 10,
"minItems": 2
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "file_upload"
},
"accept": {
"type": "array",
"items": {
"enum": [
"image",
"pdf",
"document",
"spreadsheet"
],
"type": "string"
},
"minItems": 1
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"max_files": {
"type": "integer",
"maximum": 5,
"minimum": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"title",
"body"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"body": {
"type": "array",
"items": {
"type": "string",
"maxLength": 2000
},
"maxItems": 10,
"minItems": 1
},
"type": {
"type": "string",
"const": "statement"
},
"title": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
"maxItems": 50,
"minItems": 1
},
"one_per_page": {
"type": "boolean"
}
},
"additionalProperties": false
},
"maxItems": 30,
"minItems": 1
},
"settings": {
"type": "object",
"properties": {
"autosave": {
"type": "boolean"
},
"close_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"completion": {
"type": "object",
"properties": {
"message": {
"type": "string",
"maxLength": 2000
},
"redirect_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"max_responses": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"show_branding": {
"type": "boolean"
},
"show_progress": {
"type": "boolean"
},
"collect_respondent": {
"enum": [
"none",
"email_optional",
"email_required"
],
"type": "string"
},
"one_question_per_page": {
"type": "boolean"
}
},
"additionalProperties": false
},
"description": {
"type": "string",
"maxLength": 2000
},
"hidden_fields": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"maxItems": 10
},
"schema_version": {
"type": "number",
"const": 1
}
},
"additionalProperties": false
},
"creator_email": {
"type": "string",
"description": "Optional, sandbox only: your user's email. They get the claim link by email immediately plus one reminder before the quiz expires — worth asking the user for. Never invent one."
},
"idempotency_key": {
"type": "string",
"description": "Optional. Same key within 24h returns the originally created quiz instead of a duplicate."
}
}
}Delete a quiz. Its URL stops working and responses become inaccessible. Confirm with your user before calling this.
| Argument | Type | Description |
|---|---|---|
| quiz_id* | string | Quiz id (the `id` field returned by create_quiz/list_quizzes). |
{
"type": "object",
"required": [
"quiz_id"
],
"properties": {
"quiz_id": {
"type": "string",
"description": "Quiz id (the `id` field returned by create_quiz/list_quizzes)."
}
}
}Get one quiz including its full definition. Requires an authorized account that owns the quiz.
| Argument | Type | Description |
|---|---|---|
| quiz_id* | string | Quiz id (the `id` field returned by create_quiz/list_quizzes). |
{
"type": "object",
"required": [
"quiz_id"
],
"properties": {
"quiz_id": {
"type": "string",
"description": "Quiz id (the `id` field returned by create_quiz/list_quizzes)."
}
}
}Get a quiz's funnel stats: views, started, finished, completion rate, and outcome counts.
| Argument | Type | Description |
|---|---|---|
| quiz_id* | string | Quiz id (the `id` field returned by create_quiz/list_quizzes). |
{
"type": "object",
"required": [
"quiz_id"
],
"properties": {
"quiz_id": {
"type": "string",
"description": "Quiz id (the `id` field returned by create_quiz/list_quizzes)."
}
}
}Get a single response by id.
| Argument | Type | Description |
|---|---|---|
| quiz_id* | string | Quiz id (the `id` field returned by create_quiz/list_quizzes). |
| response_id* | string | Response id. |
{
"type": "object",
"required": [
"quiz_id",
"response_id"
],
"properties": {
"quiz_id": {
"type": "string",
"description": "Quiz id (the `id` field returned by create_quiz/list_quizzes)."
},
"response_id": {
"type": "string",
"description": "Response id."
}
}
}List a quiz's responses (answers, outcome, score, timestamps), newest first (default 50 per page; the result includes total and has_more). Requires an authorized account that owns the quiz.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max responses to return (default 50). |
| offset | integer | Skip this many responses (use next_offset from the previous page). |
| quiz_id* | string | Quiz id (the `id` field returned by create_quiz/list_quizzes). |
| complete_only | boolean | If true, return only completed responses. |
{
"type": "object",
"required": [
"quiz_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max responses to return (default 50)."
},
"offset": {
"type": "integer",
"minimum": 0,
"description": "Skip this many responses (use next_offset from the previous page)."
},
"quiz_id": {
"type": "string",
"description": "Quiz id (the `id` field returned by create_quiz/list_quizzes)."
},
"complete_only": {
"type": "boolean",
"description": "If true, return only completed responses."
}
}
}Delivery status for a quiz's email sends: sent / started / completed per recipient, plus reminder counts and opt-outs.
| Argument | Type | Description |
|---|---|---|
| quiz_id* | string | Quiz id (the `id` field returned by create_quiz/list_quizzes). |
{
"type": "object",
"required": [
"quiz_id"
],
"properties": {
"quiz_id": {
"type": "string",
"description": "Quiz id (the `id` field returned by create_quiz/list_quizzes)."
}
}
}List quizzes owned by the connected QuizGen account, newest first (default 50 per page; the result includes total and has_more). Requires authorization.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max quizzes to return (default 50). |
| offset | integer | Skip this many quizzes (use next_offset from the previous page). |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max quizzes to return (default 50)."
},
"offset": {
"type": "integer",
"minimum": 0,
"description": "Skip this many quizzes (use next_offset from the previous page)."
}
}
}Email the quiz to recipients — each gets a unique tracked link so responses tie back to them (see get_sends). Any account with a confirmed email address; capped per month and per 24 hours (Free: 200/mo, 50/day; Plus: 5,000/mo). Confirm the recipient list with your user before calling: this sends real email immediately.
| Argument | Type | Description |
|---|---|---|
| message | string | Optional short note from the sender, shown above the button. |
| quiz_id* | string | Quiz id (the `id` field returned by create_quiz/list_quizzes). |
| recipients* | array |
{
"type": "object",
"required": [
"quiz_id",
"recipients"
],
"properties": {
"message": {
"type": "string",
"description": "Optional short note from the sender, shown above the button."
},
"quiz_id": {
"type": "string",
"description": "Quiz id (the `id` field returned by create_quiz/list_quizzes)."
},
"recipients": {
"type": "array",
"items": {
"type": "object",
"required": [
"email"
],
"properties": {
"name": {
"type": "string",
"description": "Optional name, used in the greeting."
},
"email": {
"type": "string",
"description": "Recipient email address."
}
}
},
"maxItems": 100
}
}
}Set (or clear with rule: null) automatic email reminders for recipients who haven't completed the quiz. Stops on completion, opt-out, or max_reminders.
| Argument | Type | Description |
|---|---|---|
| rule* | object | null | |
| quiz_id* | string | Quiz id (the `id` field returned by create_quiz/list_quizzes). |
{
"type": "object",
"required": [
"quiz_id",
"rule"
],
"properties": {
"rule": {
"type": [
"object",
"null"
],
"properties": {
"message": {
"type": "string",
"description": "Optional note used in reminder emails."
},
"after_hours": {
"type": "integer",
"maximum": 720,
"minimum": 1,
"description": "Hours to wait before each reminder (default 48)."
},
"max_reminders": {
"type": "integer",
"maximum": 5,
"minimum": 1,
"description": "Max reminders per recipient (default 2)."
}
}
},
"quiz_id": {
"type": "string",
"description": "Quiz id (the `id` field returned by create_quiz/list_quizzes)."
}
}
}Open ("live") or close ("closed") a quiz. Closed quizzes stop accepting responses but keep their data.
| Argument | Type | Description |
|---|---|---|
| status* | string | |
| quiz_id* | string | Quiz id (the `id` field returned by create_quiz/list_quizzes). |
{
"type": "object",
"required": [
"quiz_id",
"status"
],
"properties": {
"status": {
"enum": [
"live",
"closed"
],
"type": "string"
},
"quiz_id": {
"type": "string",
"description": "Quiz id (the `id` field returned by create_quiz/list_quizzes)."
}
}
}Set (url) or clear (url: null) the webhook for a quiz. Completed responses POST to the url; with a secret, requests carry an X-QuizGen-Signature HMAC-SHA256 header.
| Argument | Type | Description |
|---|---|---|
| url* | string | null | https:// URL to receive completed responses, or null to clear. |
| secret | string | Optional signing secret (min 8 chars). |
| quiz_id* | string | Quiz id (the `id` field returned by create_quiz/list_quizzes). |
{
"type": "object",
"required": [
"quiz_id",
"url"
],
"properties": {
"url": {
"type": [
"string",
"null"
],
"description": "https:// URL to receive completed responses, or null to clear."
},
"secret": {
"type": "string",
"description": "Optional signing secret (min 8 chars)."
},
"quiz_id": {
"type": "string",
"description": "Quiz id (the `id` field returned by create_quiz/list_quizzes)."
}
}
}Replace a quiz's definition (full replacement, not a patch — send the complete new definition). The quiz keeps its URL and responses. Requires an authorized account that owns the quiz.
| Argument | Type | Description |
|---|---|---|
| quiz_id* | string | Quiz id (the `id` field returned by create_quiz/list_quizzes). |
| definition* | object |
{
"type": "object",
"required": [
"quiz_id",
"definition"
],
"properties": {
"quiz_id": {
"type": "string",
"description": "Quiz id (the `id` field returned by create_quiz/list_quizzes)."
},
"definition": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"schema_version",
"title",
"sections"
],
"properties": {
"kind": {
"enum": [
"quiz",
"survey",
"form",
"email_capture",
"registration"
],
"type": "string"
},
"cover": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 300
},
"subtitle": {
"type": "string",
"maxLength": 1000
},
"image_url": {
"type": "string",
"format": "uri"
},
"button_label": {
"type": "string",
"maxLength": 60
}
},
"additionalProperties": false
},
"theme": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mode": {
"enum": [
"light",
"dark",
"auto"
],
"type": "string"
},
"accent": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"preset": {
"enum": [
"warm",
"midnight",
"forest",
"corporate",
"playful",
"mono"
],
"type": "string"
},
"logo_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"title": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"outcomes": {
"anyOf": [
{
"type": "object",
"required": [
"method",
"points",
"buckets"
],
"properties": {
"method": {
"type": "string",
"const": "points"
},
"points": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"buckets": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"title"
],
"properties": {
"key": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "number"
},
"min": {
"type": "number"
},
"body": {
"type": "string",
"maxLength": 2000
},
"title": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"redirect_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"maxItems": 20,
"minItems": 1
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"questions"
],
"properties": {
"key": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"blurb": {
"type": "string",
"maxLength": 1000
},
"title": {
"type": "string",
"maxLength": 300
},
"questions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "short_text"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"placeholder": {
"type": "string",
"maxLength": 200
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"rows": {
"type": "integer",
"maximum": 20,
"minimum": 2
},
"type": {
"type": "string",
"const": "long_text"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"examples": {
"type": "array",
"items": {
"type": "string",
"maxLength": 300
},
"maxItems": 8
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt",
"options"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "choice"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"label"
],
"properties": {
"label": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"value": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"detail": {
"type": "string",
"maxLength": 500
},
"image_url": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
"maxItems": 20,
"minItems": 2
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"follow_up": {
"type": "string",
"maxLength": 500
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt",
"options"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
"min": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "multi_choice"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"label"
],
"properties": {
"label": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"value": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"detail": {
"type": "string",
"maxLength": 500
},
"image_url": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
"maxItems": 20,
"minItems": 2
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "integer",
"maximum": 10,
"minimum": 2
},
"min": {
"type": "integer",
"maximum": 1,
"minimum": 0
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "scale"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"max_label": {
"type": "string",
"maxLength": 100
},
"min_label": {
"type": "string",
"maxLength": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "email"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"placeholder": {
"type": "string",
"maxLength": 200
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "number"
},
"min": {
"type": "number"
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "number"
},
"unit": {
"type": "string",
"maxLength": 30
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"min": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "date"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "time"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "phone"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"placeholder": {
"type": "string",
"maxLength": 200
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "url"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"placeholder": {
"type": "string",
"maxLength": 200
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "yes_no"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"no_label": {
"type": "string",
"maxLength": 100
},
"required": {
"type": "boolean"
},
"yes_label": {
"type": "string",
"maxLength": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "consent"
},
"terms": {
"type": "object",
"required": [
"title",
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 20000,
"minLength": 1
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"version": {
"type": "string",
"maxLength": 100,
"minLength": 1
}
},
"additionalProperties": false
},
"prompt": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "signature"
},
"terms": {
"type": "object",
"required": [
"title",
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 20000,
"minLength": 1
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"version": {
"type": "string",
"maxLength": 100,
"minLength": 1
}
},
"additionalProperties": false
},
"prompt": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "integer",
"maximum": 10,
"minimum": 2
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "rating"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"max": {
"type": "number"
},
"min": {
"type": "number"
},
"help": {
"type": "string",
"maxLength": 1000
},
"step": {
"type": "number",
"exclusiveMinimum": 0
},
"type": {
"type": "string",
"const": "slider"
},
"unit": {
"type": "string",
"maxLength": 30
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"max_label": {
"type": "string",
"maxLength": 100
},
"min_label": {
"type": "string",
"maxLength": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "payment"
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"currency": {
"type": "string",
"pattern": "^[a-z]{3}$"
},
"required": {
"type": "boolean"
},
"amount_cents": {
"type": "integer",
"maximum": 1000000,
"minimum": 50
},
"button_label": {
"type": "string",
"maxLength": 60
},
"price_options": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"label",
"amount_cents"
],
"properties": {
"label": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"value": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"detail": {
"type": "string",
"maxLength": 500
},
"amount_cents": {
"type": "integer",
"maximum": 1000000,
"minimum": 50
}
},
"additionalProperties": false
},
"maxItems": 10,
"minItems": 2
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"help": {
"type": "string",
"maxLength": 1000
},
"type": {
"type": "string",
"const": "file_upload"
},
"accept": {
"type": "array",
"items": {
"enum": [
"image",
"pdf",
"document",
"spreadsheet"
],
"type": "string"
},
"minItems": 1
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"required": {
"type": "boolean"
},
"max_files": {
"type": "integer",
"maximum": 5,
"minimum": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"title",
"body"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"body": {
"type": "array",
"items": {
"type": "string",
"maxLength": 2000
},
"maxItems": 10,
"minItems": 1
},
"type": {
"type": "string",
"const": "statement"
},
"title": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"show_if": {
"type": "object",
"required": [
"question",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"in",
"gte",
"lte",
"answered"
],
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"question": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
"maxItems": 50,
"minItems": 1
},
"one_per_page": {
"type": "boolean"
}
},
"additionalProperties": false
},
"maxItems": 30,
"minItems": 1
},
"settings": {
"type": "object",
"properties": {
"autosave": {
"type": "boolean"
},
"close_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"completion": {
"type": "object",
"properties": {
"message": {
"type": "string",
"maxLength": 2000
},
"redirect_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"max_responses": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"show_branding": {
"type": "boolean"
},
"show_progress": {
"type": "boolean"
},
"collect_respondent": {
"enum": [
"none",
"email_optional",
"email_required"
],
"type": "string"
},
"one_question_per_page": {
"type": "boolean"
}
},
"additionalProperties": false
},
"description": {
"type": "string",
"maxLength": 2000
},
"hidden_fields": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9_]+$",
"maxLength": 64,
"minLength": 1
},
"maxItems": 10
},
"schema_version": {
"type": "number",
"const": 1
}
},
"additionalProperties": false
}
}
}