Skip to main content
GET
/
lead
/
{lead_list_id}
/
Retrieve Lead List
curl --request GET \
  --url https://management.scanova.io/lead/{lead_list_id}/ \
  --header 'Authorization: <api-key>'
{
  "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"
    }
  ],
  "data": "[{\"type\":\"page_title\",\"data\":{\"title\":\"<p>TEST FOR NEW LEAD NOPW</p>\\n\",\"cardStyle\":{\"backgroundColor\":\"#F8F8F8\"}}}]",
  "webhooks": [
    {
      "id": 16,
      "url": "https://webhook.site/8e85fafd-a4d0-433b-bf80-5bb11eed4ea6",
      "created": "2023-06-20T16:24:00.060154+05:30",
      "modified": "2023-06-20T16:24:03.157414+05:30"
    }
  ]
}

​
Overview

Retrieves detailed information about a specific lead list, including its configuration, linked QR codes, and webhook settings.

​
Path Parameters

ParameterTypeRequiredDescriptionExample
lead_list_idstringYesLead list ID (lead_id)Lecb6be7be43b4724

​
Response

Returns a complete lead list object with the following additional fields:
  • data: JSON string containing the lead list form configuration
  • webhooks: Array of webhook configurations for this lead list

​
Lead List Configuration

The data field contains a JSON string with the lead list form configuration, including:
  • Page Title: Title displayed on the lead capture page
  • Page Layout: Background color and styling
  • Description Box: Additional text or instructions
  • Banner Images: Images displayed on the page
  • Lead Form: Form fields and questions
  • Submit Button: Styling and text for the submit button
  • Skip Button: Styling and text for the skip button

​
Webhooks

The webhooks array contains webhook configurations that will be triggered when leads are captured:
  • id: Webhook ID
  • url: Webhook endpoint URL
  • created: Webhook creation timestamp
  • modified: Webhook last modification timestamp

​
Examples

​
Retrieve Lead List Details

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

​
Response Example

{
  "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"
    }
  ],
  "data": "[{\"type\":\"page_title\",\"data\":{\"title\":\"<p>TEST FOR NEW LEAD NOPW</p>\\n\",\"cardStyle\":{\"backgroundColor\":\"#F8F8F8\"}}}]",
  "webhooks": [
    {
      "id": 16,
      "url": "https://webhook.site/8e85fafd-a4d0-433b-bf80-5bb11eed4ea6",
      "created": "2023-06-20T16:24:00.060154+05:30",
      "modified": "2023-06-20T16:24:03.157414+05:30"
    }
  ]
}

​
Use Cases

  • Form Configuration: Get the complete form configuration for editing
  • Analytics: View usage statistics and linked QR codes
  • Webhook Management: Check webhook configurations
  • Integration: Use lead list details for third-party integrations
The data field contains a complex JSON structure that defines the entire lead capture form. This includes styling, form fields, and user interface elements.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
lead_list_id
string
required

Lead list ID (lead_id)

Response

Lead list details

​
id
integer

Internal lead list ID

Example:

262

​
lead_id
string

Unique lead list identifier

Example:

"Lecb6be7be43b4724"

​
name
string

Name of the lead list

Example:

"Onit Lead"

​
created
string<date-time>

Creation timestamp

Example:

"2023-08-04T13:51:51.959871+05:30"

​
modified
string<date-time>

Last modification timestamp

Example:

"2023-08-04T13:51:51.959871+05:30"

​
is_active
boolean

Whether the lead list is active

Example:

true

​
usage_count
integer

Number of times this lead list has been used

Example:

5

​
entries_count
integer

Number of lead entries in this list

Example:

7

​
linked_qrs
object[]

QR codes linked to this lead list

​
data
string

JSON string containing lead list form configuration

Example:

"[{\"type\":\"page_title\",\"data\":{\"title\":\"<p>TEST FOR NEW LEAD NOPW</p>\\n\",\"cardStyle\":{\"backgroundColor\":\"#F8F8F8\"}}},{\"type\":\"page_layout\",\"data\":{\"backgroundColor\":\"0a2e9b\"}},{\"type\":\"description_box\",\"data\":{\"text\":\"<p>NEW LEAD NEW</p>\\n\",\"cardStyle\":{\"backgroundColor\":\"#F8F8F8\"}}},{\"type\":\"banner_images\",\"data\":{\"images\":[{\"url\":\"https://qcg7-storage-staging.s3.amazonaws.com/media/uploads/560/2023/06/20230620_462316_qrcode.png\"}]}},{\"type\":\"lead_form\",\"data\":{\"description\":\"Food Preference\",\"questions\":[{\"question\":\"FOOD PREFERENCES\",\"answer\":{\"type\":\"multipleChoice\",\"data\":[{\"option\":\"VEG\"},{\"option\":\"NON VEG\"}]},\"isRequired\":true}]}},{\"type\":\"submit_button\",\"data\":{\"label\":\"SUBMIT\",\"color\":{\"label\":\"#585858\",\"button\":\"#F8F8F8\",\"border\":\"#F8F8F8\"},\"buttonStyle\":{\"borderWidth\":1,\"borderRadius\":50}}},{\"type\":\"skip_button\",\"data\":{\"label\":\"SKIP\",\"color\":{\"label\":\"#585858\",\"button\":\"#F8F8F8\",\"border\":\"#F8F8F8\"},\"buttonStyle\":{\"borderWidth\":1,\"borderRadius\":50}}}]"

​
webhooks
object[]

Webhooks configured for this lead list