Retrieve Form

Retrieve Form

curl --request GET \
  --url https://management.scanova.io/form/{form_id}/ \
  --header 'Authorization: <api-key>'

import requests

url = "https://management.scanova.io/form/{form_id}/"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://management.scanova.io/form/{form_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://management.scanova.io/form/{form_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://management.scanova.io/form/{form_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://management.scanova.io/form/{form_id}/")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://management.scanova.io/form/{form_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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\"}}]"
}

{
  "detail": "Invalid token."
}

{
  "detail": "Not found."
}

GET

form

{form_id}

Retrieve Form

curl --request GET \
  --url https://management.scanova.io/form/{form_id}/ \
  --header 'Authorization: <api-key>'

import requests

url = "https://management.scanova.io/form/{form_id}/"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://management.scanova.io/form/{form_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://management.scanova.io/form/{form_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://management.scanova.io/form/{form_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://management.scanova.io/form/{form_id}/")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://management.scanova.io/form/{form_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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\"}}]"
}

{
  "detail": "Invalid token."
}

{
  "detail": "Not found."
}

Overview

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

Path Parameters

Parameter	Type	Required	Description	Example
`form_id`	string	Yes	Form 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

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

Show child attributes

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\"}}]"

List Form Update Form

Getting Started

Reference

QR Code Management

Folder Management

Form Management

Lead List Management

User Management

Analytics & Reporting

Conversion Tracking

Overview

Path Parameters

Response

Form Configuration

Examples

Retrieve Form Details

Response Example

Use Cases

Authorizations

Path Parameters

Response

​Overview

​Path Parameters

​Response

​Form Configuration

​Examples

​Retrieve Form Details

​Response Example

​Use Cases

Authorizations

Path Parameters

Response

Overview

Path Parameters

Response

Form Configuration

Examples

Retrieve Form Details

Response Example

Use Cases