Skip to main content
GET
/
form
List Forms
curl --request GET \
  --url https://management.scanova.io/form/ \
  --header 'Authorization: <api-key>'
{
  "count": 5,
  "next": null,
  "previous": null,
  "results": [
    {
      "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"
        }
      ]
    }
  ]
}

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 all forms with optional filtering by active status. This endpoint allows you to get a paginated list of all forms in your account.

​
Query Parameters

ParameterTypeRequiredDescriptionExample
is_activebooleanNoFilter forms by active statustrue or false

​
Response

The response includes a paginated list of forms with the following structure:
  • count: Total number of forms
  • next: URL for next page (null if no more pages)
  • previous: URL for previous page (null if first page)
  • results: Array of form objects

​
Form Object

Each form object contains:
  • id: Internal form ID
  • form_id: Unique form identifier
  • name: Name of the form
  • created: Creation timestamp
  • modified: Last modification timestamp
  • is_active: Whether the form is active
  • usage_count: Number of QR codes this form is linked to
  • entries_count: Number of form submissions collected
  • conversion: Conversion rate as a percentage (entries / total scans × 100)
  • linked_qrs: Array of QR codes linked to this form

​
Examples

​
Get All Forms

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

​
Get Only Active Forms

curl -X GET "https://management.scanova.io/form/?is_active=true" \
  -H "Authorization: YOUR_API_KEY"

​
Get Only Inactive Forms

curl -X GET "https://management.scanova.io/form/?is_active=false" \
  -H "Authorization: YOUR_API_KEY"

​
Use Cases

  • Dashboard Overview: Display all forms in your account
  • Active Management: Filter to show only active forms
  • Analytics: Get usage statistics and conversion rates for forms
  • QR Code Integration: See which QR codes are linked to each form
Forms are the recommended way to capture user information when QR codes are scanned. They replace the legacy Lead Lists feature. Each form can be attached to multiple QR codes, but each QR code can only have one form attached at a time.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
is_active
boolean

Filter forms by active status

Response

List of forms

​
count
integer

Total number of forms

Example:

5

​
next
string

URL for next page of results

Example:

null

​
previous
string

URL for previous page of results

Example:

null

​
results
object[]