Skip to main content
GET
/
form
/
{form_id}
Retrieve Form
curl --request GET \
  --url https://management.scanova.io/form/{form_id}/ \
  --header 'Authorization: <api-key>'
{
  "id": 301,
  "form_id": "Fecb6be7be43b4724",
  "name": "Customer Feedback Form",
  "created": "2024-03-15T10:30:00.000000+05:30",
  "modified": "2024-03-15T10:30:00.000000+05:30",
  "is_active": true,
  "usage_count": 3,
  "entries_count": 42,
  "conversion": 68.5,
  "linked_qrs": [
    {
      "qr_code__id": 150157,
      "qr_code__qrid": "Qff07909fe1c14923",
      "qr_code__name": "Event Booth QR",
      "qr_code__qr_type": "dy"
    }
  ],
  "data": "[{\"type\":\"page_layout\",\"data\":{\"themeId\":\"ocean-clean\"}},{\"type\":\"design_info\",\"data\":{\"color\":{\"background\":\"#C1E8FA\"},\"button\":{\"color\":\"#2D2B2B\",\"textColor\":\"#FFFFFF\",\"cornerRadius\":2,\"fontFamily\":\"Inter\",\"showDropShadow\":false},\"text\":{\"headerTitle\":{\"color\":\"#2D2B2B\",\"fontFamily\":\"Inter\",\"fontSize\":1},\"body\":{\"color\":\"#2D2B2B\",\"fontFamily\":\"Inter\",\"fontSize\":1},\"privacy\":{\"color\":\"#2D2B2B\",\"fontFamily\":\"Inter\",\"fontSize\":1}}}},{\"type\":\"form_details\",\"data\":{\"title\":\"Get in Touch with Us\",\"description\":\"Interested in our services? Fill out the form and we'll get back to you.\",\"questions\":[{\"question\":\"Full Name\",\"answer\":{\"type\":\"shortAnswer\"},\"isRequired\":true}]}},{\"type\":\"submit_button\",\"data\":{\"label\":\"Submit\"}},{\"type\":\"skip_button\",\"data\":{\"label\":\"Skip\"}}]"
}

Documentation Index

Fetch the complete documentation index at: https://docs.scanova.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Retrieves detailed information about a specific form, including its configuration, linked QR codes, and submission statistics.

​
Path Parameters

ParameterTypeRequiredDescriptionExample
form_idstringYesForm ID (form_id)Fecb6be7be43b4724

​
Response

Returns a complete form object with the following additional fields:
  • data: JSON string containing the form configuration
  • conversion: Conversion rate as a percentage (entries / total scans × 100)

​
Form Configuration

The data field contains a JSON string with the form configuration, including:
  • Page Layout (page_layout): Background color and styling
  • Design Info (design_info): Button styles, text styles, and color theme
  • Form Details (form_details): Page title, description, and form questions
  • Submit Button (submit_button): Styling and label for the submit button
  • Skip Button (skip_button): Styling and label for the skip button

​
Examples

​
Retrieve Form Details

curl -X GET "https://management.scanova.io/form/Fecb6be7be43b4724/" \
  -H "Authorization: YOUR_API_KEY"

​
Response Example

{
  "id": 301,
  "form_id": "Fecb6be7be43b4724",
  "name": "Customer Feedback Form",
  "created": "2024-03-15T10:30:00.000000+05:30",
  "modified": "2024-03-15T10:30:00.000000+05:30",
  "is_active": true,
  "usage_count": 3,
  "entries_count": 42,
  "conversion": 68.5,
  "linked_qrs": [
    {
      "qr_code__id": 150157,
      "qr_code__qrid": "Qff07909fe1c14923",
      "qr_code__name": "Event Booth QR",
      "qr_code__qr_type": "dy"
    }
  ],
  "data": "[{\"type\":\"page_layout\",\"data\":{\"themeId\":\"ocean-clean\"}},{\"type\":\"design_info\",\"data\":{\"color\":{\"background\":\"#C1E8FA\"},\"button\":{\"color\":\"#2D2B2B\",\"textColor\":\"#FFFFFF\",\"cornerRadius\":2,\"fontFamily\":\"Inter\",\"showDropShadow\":false},\"text\":{\"headerTitle\":{\"color\":\"#2D2B2B\",\"fontFamily\":\"Inter\",\"fontSize\":1},\"body\":{\"color\":\"#2D2B2B\",\"fontFamily\":\"Inter\",\"fontSize\":1},\"privacy\":{\"color\":\"#2D2B2B\",\"fontFamily\":\"Inter\",\"fontSize\":1}}}},{\"type\":\"form_details\",\"data\":{\"title\":\"Get in Touch with Us\",\"description\":\"Interested in our services? Fill out the form and we'll get back to you.\",\"questions\":[{\"question\":\"Full Name\",\"answer\":{\"type\":\"shortAnswer\"},\"isRequired\":true}]}},{\"type\":\"submit_button\",\"data\":{\"label\":\"Submit\"}},{\"type\":\"skip_button\",\"data\":{\"label\":\"Skip\"}}]"
}

​
Use Cases

  • Form Configuration: Get the complete form configuration for editing
  • Analytics: View submission statistics, conversion rate, and linked QR codes
  • Integration: Use form details for third-party integrations
The data field contains a JSON structure that defines the entire form. Supported component types are: page_layout, design_info, form_details, submit_button, and skip_button.

Authorizations

​
Authorization
string
header
required

API key authentication. Enter your API key directly in the Authorization header.

Path Parameters

​
form_id
string
required

Form ID (form_id)

Response

Form details

​
id
integer

Internal form ID

Example:

301

​
form_id
string

Unique form identifier

Example:

"Fecb6be7be43b4724"

​
name
string

Name of the form

Example:

"Customer Feedback Form"

​
created
string<date-time>

Creation timestamp

Example:

"2024-03-15T10:30:00.000000+05:30"

​
modified
string<date-time>

Last modification timestamp

Example:

"2024-03-15T10:30:00.000000+05:30"

​
is_active
boolean

Whether the form is active

Example:

true

​
usage_count
integer

Number of QR codes this form is linked to

Example:

3

​
entries_count
integer

Number of form submissions collected

Example:

42

​
conversion
number<float>

Conversion rate as a percentage (entries / total scans * 100)

Example:

68.5

​
linked_qrs
object[]

QR codes linked to this form

​
data
string

JSON string containing the form configuration

Example:

"[{\"type\":\"page_layout\",\"data\":{\"themeId\":\"ocean-clean\"}},{\"type\":\"design_info\",\"data\":{\"color\":{\"background\":\"#C1E8FA\"},\"button\":{\"color\":\"#2D2B2B\",\"textColor\":\"#FFFFFF\",\"cornerRadius\":2,\"fontFamily\":\"Inter\",\"showDropShadow\":false},\"text\":{\"headerTitle\":{\"color\":\"#2D2B2B\",\"fontFamily\":\"Inter\",\"fontSize\":1},\"body\":{\"color\":\"#2D2B2B\",\"fontFamily\":\"Inter\",\"fontSize\":1},\"privacy\":{\"color\":\"#2D2B2B\",\"fontFamily\":\"Inter\",\"fontSize\":1}}}},{\"type\":\"form_details\",\"data\":{\"title\":\"Get in Touch with Us\",\"description\":\"Interested in our services? Fill out the form and we'll get back to you.\",\"questions\":[{\"question\":\"Full Name\",\"answer\":{\"type\":\"shortAnswer\"},\"isRequired\":true}]}},{\"type\":\"submit_button\",\"data\":{\"label\":\"Submit\"}},{\"type\":\"skip_button\",\"data\":{\"label\":\"Skip\"}}]"