curl --request GET \
--url https://management.scanova.io/lead/{lead_list_id}/ \
--header 'Authorization: <api-key>'import requests
url = "https://management.scanova.io/lead/{lead_list_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/lead/{lead_list_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/lead/{lead_list_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/lead/{lead_list_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/lead/{lead_list_id}/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://management.scanova.io/lead/{lead_list_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": 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"
}
]
}Retrieve Lead List
Retrieves details of a specific lead list. Requires authentication.
curl --request GET \
--url https://management.scanova.io/lead/{lead_list_id}/ \
--header 'Authorization: <api-key>'import requests
url = "https://management.scanova.io/lead/{lead_list_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/lead/{lead_list_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/lead/{lead_list_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/lead/{lead_list_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/lead/{lead_list_id}/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://management.scanova.io/lead/{lead_list_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": 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
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
lead_list_id | string | Yes | Lead 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 configurationwebhooks: Array of webhook configurations for this lead list
Lead List Configuration
Thedata 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
Thewebhooks array contains webhook configurations that will be triggered when leads are captured:
id: Webhook IDurl: Webhook endpoint URLcreated: Webhook creation timestampmodified: 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
data field contains a complex JSON structure that defines the entire lead capture form. This includes styling, form fields, and user interface elements.Authorizations
Response
Lead list details
JSON string containing lead list form configuration
"[{\"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}}}]"
Was this page helpful?