> ## 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.

# Retrieve Lead List

> Retrieves details of a specific lead list. Requires authentication.

## 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 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

```bash theme={null}
curl -X GET "https://management.scanova.io/lead/Lecb6be7be43b4724/" \
  -H "Authorization: YOUR_API_KEY"
```

### Response Example

```json theme={null}
{
  "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

<Note>
  The `data` field contains a complex JSON structure that defines the entire lead capture form. This includes styling, form fields, and user interface elements.
</Note>


## OpenAPI

````yaml GET /lead/{lead_list_id}/
openapi: 3.1.0
info:
  title: Scanova Lead List API
  description: >-
    Lead list management endpoints for creating, updating, and managing lead
    lists
  version: 1.0.0
servers:
  - url: https://management.scanova.io
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: Lead List
    description: Lead list management operations
paths:
  /lead/{lead_list_id}/:
    get:
      tags:
        - Lead List
      summary: Retrieve Lead List
      description: Retrieves details of a specific lead list. Requires authentication.
      parameters:
        - name: lead_list_id
          in: path
          required: true
          description: Lead list ID (lead_id)
          schema:
            type: string
          example: Lecb6be7be43b4724
      responses:
        '200':
          description: Lead list details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeadList'
              examples:
                lead_list_details:
                  summary: Lead list details
                  value:
                    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'
        '401':
          description: Unauthorized - Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationErrorResponse'
        '404':
          description: Lead list not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    LeadList:
      type: object
      properties:
        id:
          type: integer
          description: Internal lead list ID
          example: 262
        lead_id:
          type: string
          description: Unique lead list identifier
          example: Lecb6be7be43b4724
        name:
          type: string
          description: Name of the lead list
          example: Onit Lead
        created:
          type: string
          format: date-time
          description: Creation timestamp
          example: '2023-08-04T13:51:51.959871+05:30'
        modified:
          type: string
          format: date-time
          description: Last modification timestamp
          example: '2023-08-04T13:51:51.959871+05:30'
        is_active:
          type: boolean
          description: Whether the lead list is active
          example: true
        usage_count:
          type: integer
          description: Number of times this lead list has been used
          example: 5
        entries_count:
          type: integer
          description: Number of lead entries in this list
          example: 7
        linked_qrs:
          type: array
          description: QR codes linked to this lead list
          items:
            type: object
            properties:
              qr_code__id:
                type: integer
                example: 150157
              qr_code__qrid:
                type: string
                example: Qff07909fe1c14923
              qr_code__name:
                type: string
                example: Androd
              qr_code__qr_type:
                type: string
                example: dy
        data:
          type: string
          description: 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:
          type: array
          description: Webhooks configured for this lead list
          items:
            type: object
            properties:
              id:
                type: integer
                example: 16
              url:
                type: string
                example: https://webhook.site/8e85fafd-a4d0-433b-bf80-5bb11eed4ea6
              created:
                type: string
                format: date-time
                example: '2023-06-20T16:24:00.060154+05:30'
              modified:
                type: string
                format: date-time
                example: '2023-06-20T16:24:03.157414+05:30'
    AuthenticationErrorResponse:
      type: object
      properties:
        detail:
          type: string
          description: Authentication error message
          example: Invalid token.
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
          description: Error message
          example: Not found.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Enter your API key directly in the Authorization
        header.

````