Skip to main content
GET
/
lead
List Lead Lists
curl --request GET \
  --url https://management.scanova.io/lead/ \
  --header 'Authorization: <api-key>'
{
  "count": 4,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 262,
      "lead_id": "Lecb6be7be43b4724",
      "name": "Onit Lead",
      "created": "2023-08-04T13:51:51.959871+05:30",
      "is_active": true,
      "usage_count": 5,
      "entries_count": 7,
      "linked_qrs": [
        {
          "qr_code__id": 150157,
          "qr_code__qrid": "Qff07909fe1c14923",
          "qr_code__name": "Androd",
          "qr_code__qr_type": "dy"
        }
      ]
    }
  ]
}

​
Overview

Retrieves all lead lists with optional filtering by active status. This endpoint allows you to get a paginated list of all lead lists in your account.

​
Query Parameters

ParameterTypeRequiredDescriptionExample
is_activebooleanNoFilter lead lists by active statustrue or false

​
Response

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

​
Lead List Object

Each lead list object contains:
  • id: Internal lead list ID
  • lead_id: Unique lead list identifier
  • name: Name of the lead list
  • created: Creation timestamp
  • modified: Last modification timestamp
  • is_active: Whether the lead list is active
  • usage_count: Number of times this lead list has been used
  • entries_count: Number of lead entries in this list
  • linked_qrs: Array of QR codes linked to this lead list

​
Examples

​
Get All Lead Lists

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

​
Get Only Active Lead Lists

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

​
Get Only Inactive Lead Lists

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

​
Use Cases

  • Dashboard Overview: Display all lead lists in your account
  • Active Management: Filter to show only active lead lists
  • Analytics: Get usage statistics for lead lists
  • QR Code Integration: See which QR codes are linked to each lead list
Lead lists are used to capture user information when QR codes are scanned. Each lead list can be attached to multiple QR codes, but each QR code can only have one lead list attached.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
is_active
boolean

Filter lead lists by active status

Response

List of lead lists

​
count
integer

Total number of lead lists

Example:

4

​
next
string

URL for next page of results

Example:

null

​
previous
string

URL for previous page of results

Example:

null

​
results
object[]