> ## 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. # List Lead Lists > Retrieves all lead lists with optional filtering. Requires authentication. ## 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 | Parameter | Type | Required | Description | Example | | ----------- | ------- | -------- | ---------------------------------- | ----------------- | | `is_active` | boolean | No | Filter lead lists by active status | `true` 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 ```bash theme={null} curl -X GET "https://management.scanova.io/lead/" \ -H "Authorization: YOUR_API_KEY" ``` ### Get Only Active Lead Lists ```bash theme={null} curl -X GET "https://management.scanova.io/lead/?is_active=true" \ -H "Authorization: YOUR_API_KEY" ``` ### Get Only Inactive Lead Lists ```bash theme={null} 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. ## OpenAPI ````yaml GET /lead/ 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/: get: tags: - Lead List summary: List Lead Lists description: >- Retrieves all lead lists with optional filtering. Requires authentication. parameters: - name: is_active in: query description: Filter lead lists by active status required: false schema: type: boolean examples: active: summary: Active lead lists value: true description: Returns only active lead lists inactive: summary: Inactive lead lists value: false description: Returns only inactive lead lists responses: '200': description: List of lead lists content: application/json: schema: $ref: '#/components/schemas/LeadListListResponse' examples: active_lead_lists: summary: Active lead lists value: 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 '401': description: Unauthorized - Invalid API key content: application/json: schema: $ref: '#/components/schemas/AuthenticationErrorResponse' security: - apiKeyAuth: [] components: schemas: LeadListListResponse: type: object properties: count: type: integer description: Total number of lead lists example: 4 next: type: string description: URL for next page of results example: null previous: type: string description: URL for previous page of results example: null results: type: array items: $ref: '#/components/schemas/LeadList' AuthenticationErrorResponse: type: object properties: detail: type: string description: Authentication error message example: Invalid token. 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":"

TEST FOR NEW LEAD NOPW

\n","cardStyle":{"backgroundColor":"#F8F8F8"}}},{"type":"page_layout","data":{"backgroundColor":"0a2e9b"}},{"type":"description_box","data":{"text":"

NEW LEAD NEW

\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' securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: >- API key authentication. Enter your API key directly in the Authorization header. ````