curl --request GET \
--url https://api.example.com/api/v1/forms/{formId}{
"id": "<string>",
"name": "<string>",
"title": "<string>",
"description": "<string>",
"formType": "<string>",
"formTypeDisplay": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"submissionCount": 123,
"fields": [
{
"id": "<string>",
"name": "<string>",
"label": "<string>",
"type": "<string>",
"required": true,
"placeholder": "<string>",
"options": [
{}
],
"products": [
{}
],
"displayMode": "<string>",
"productIds": [
{}
]
}
],
"emailSettings": {
"enabled": true,
"developerNotificationsEnabled": true
},
"usersJoinedSettings": {
"enabled": true,
"count": 123
},
"formTypeSpecific": {},
"error": "<string>"
}Retrieve detailed information about a specific form including its schema, fields, and settings
curl --request GET \
--url https://api.example.com/api/v1/forms/{formId}{
"id": "<string>",
"name": "<string>",
"title": "<string>",
"description": "<string>",
"formType": "<string>",
"formTypeDisplay": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"submissionCount": 123,
"fields": [
{
"id": "<string>",
"name": "<string>",
"label": "<string>",
"type": "<string>",
"required": true,
"placeholder": "<string>",
"options": [
{}
],
"products": [
{}
],
"displayMode": "<string>",
"productIds": [
{}
]
}
],
"emailSettings": {
"enabled": true,
"developerNotificationsEnabled": true
},
"usersJoinedSettings": {
"enabled": true,
"count": 123
},
"formTypeSpecific": {},
"error": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://mintlify.com/artistatbl/Mantlz/llms.txt
Use this file to discover all available pages before exploring further.
X-API-Key headerapiKey query parameterX-API-Key header instead.Show Field Object
Show Type-Specific Config Examples
surveyVersion: Version of the surveysupportsAnalytics: Whether analytics are supportedsupportsRating: Whether rating functionality is supportedcookieConsent: Cookie consent enableddataPrivacy: Data privacy settings enabledsupportsPayment: Whether payment is supported (future feature)shippingRequired: Whether shipping information is requiredattendanceTracking: Whether attendance tracking is enabledX-RateLimit-Limit: Maximum number of requests allowedX-RateLimit-Remaining: Number of requests remaining in the current windowX-RateLimit-Reset: Unix timestamp when the rate limit resets400 - Bad Request: Invalid parameters401 - Unauthorized: Invalid or inactive API key404 - Not Found: Form not found or user not found429 - Too Many Requests: Rate limit exceeded500 - Internal Server Errorcurl -X GET "https://api.mantlz.app/api/v1/forms/clx1234567890abcdef" \
-H "X-API-Key: your_api_key_here"
{
"id": "clx1234567890abcdef",
"name": "Product Feedback Survey",
"title": "Product Feedback Survey",
"description": "Collect user feedback on our products",
"formType": "feedback",
"formTypeDisplay": "Feedback",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-03-01T14:22:00.000Z",
"submissionCount": 42,
"fields": [
{
"id": "email",
"name": "email",
"label": "Email Address",
"type": "email",
"required": true,
"placeholder": "your@email.com"
},
{
"id": "rating",
"name": "rating",
"label": "How would you rate our product?",
"type": "select",
"required": true,
"placeholder": "Select a rating",
"options": ["1 - Poor", "2 - Fair", "3 - Good", "4 - Very Good", "5 - Excellent"]
},
{
"id": "comments",
"name": "comments",
"label": "Additional Comments",
"type": "textarea",
"required": false,
"placeholder": "Share your thoughts..."
}
],
"emailSettings": {
"enabled": true,
"developerNotificationsEnabled": false
},
"usersJoinedSettings": null,
"formTypeSpecific": {
"supportsRating": true
}
}
fields array is parsed from the form’s JSON schemaformTypeSpecific object contains different properties depending on the formType