> ## Documentation Index
> Fetch the complete documentation index at: https://docs.renovationfind.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List general leads

> Paginated list of general leads with optional filtering by view, filter, and search query.
Maximum page size is 50.




## OpenAPI

````yaml /openapi-manager.yaml get /general-leads
openapi: 3.0.3
info:
  title: RenovationFind Manager API
  description: >
    Internal REST API for RenovationFind manager operations.


    ## Authentication

    All endpoints require a Bearer token in the `Authorization` header.

    Tokens are issued from the RenovationFind Manager Portal.


    ```

    Authorization: Bearer <your_jwt_token>

    ```


    ## Rate Limiting

    API requests are rate-limited to **250 requests per 5 minutes** per manager.

    When exceeded, the API returns `429 Too Many Requests` with a `Retry-After`
    header.


    ## Response Format

    All responses follow a consistent envelope:

    ```json

    {
      "success": true,
      "data": { ... },
      "message": "Optional message"
    }

    ```

    On error:

    ```json

    {
      "success": false,
      "error": "Error description"
    }

    ```


    ## Partial Updates

    All PATCH endpoints accept partial payloads. Only provided (non-null) fields
    are applied;

    omitted fields remain unchanged. Date fields use `dd/MM/yyyy` format.
  version: 1.0.0
  contact:
    name: RenovationFind
    url: https://www.renovationfind.com
servers:
  - url: https://www.renovationfind.com/rest-manager-api-v1
    description: Production
security:
  - BearerAuth: []
paths:
  /general-leads:
    get:
      tags:
        - General Leads
      summary: List general leads
      description: >
        Paginated list of general leads with optional filtering by view, filter,
        and search query.

        Maximum page size is 50.
      operationId: getGeneralLeads
      parameters:
        - name: view
          in: query
          schema:
            type: string
            enum:
              - ALL
              - PQ
              - PAP
              - ACTION_REQUIRED
            default: ALL
        - name: filter
          in: query
          required: false
          schema:
            type: string
            enum:
              - ALL
              - NEW
              - ATTEMPTED_CONTACT
              - LONG_TERM_FOLLOW_UP
              - READY_TO_SEND
              - PQR_LEAD_SENT
              - PAP_LEAD_SENT
              - FOLLOW_UP_CALL
              - CLOSED_DEAL
              - JOB_FINISHED
              - FAILED
              - NEW_UNPROCESSED
              - ACKNOWLEDGED
              - FULLY_PROCESSED
              - PQR_LEAD
              - PAP_LEAD
        - name: searchQuery
          in: query
          schema:
            type: string
            default: ''
            maxLength: 200
        - name: page
          in: query
          schema:
            type: integer
            default: 0
        - name: size
          in: query
          schema:
            type: integer
            default: 10
            maximum: 50
      responses:
        '200':
          description: Paginated general leads
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      content:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              format: int64
                            customerName:
                              type: string
                            dateCreated:
                              type: string
                              format: date-time
                            dateModified:
                              type: string
                              format: date-time
                            renofindLeadType:
                              type: string
                            generalLeadStatus:
                              type: string
                            specificLeadStatus:
                              type: string
                            paymentStatus:
                              type: string
                            leadSourceType:
                              type: string
                            phoneLead:
                              type: boolean
                            referrerVendorId:
                              type: integer
                              format: int64
                            referrerName:
                              type: string
                            endCustomer:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  format: int64
                                name:
                                  type: string
                                email:
                                  type: string
                                phone:
                                  type: string
                            jobAmount:
                              type: number
                              format: double
                            requiresAction:
                              type: boolean
                            requireActionReason:
                              type: string
                      totalElements:
                        type: integer
                        format: int64
                      totalPages:
                        type: integer
                      size:
                        type: integer
                      number:
                        type: integer
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token issued from the RenovationFind Manager Portal

````