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

# Search vendors for a general lead

> Searches for matching vendors by category, with optional postal code and city/province filtering.
Results include budget match info and optional AI similarity scoring.




## OpenAPI

````yaml /openapi-manager.yaml get /general-leads/{generalLeadId}/vendor-list
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/{generalLeadId}/vendor-list:
    get:
      tags:
        - General Leads
      summary: Search vendors for a general lead
      description: >
        Searches for matching vendors by category, with optional postal code and
        city/province filtering.

        Results include budget match info and optional AI similarity scoring.
      operationId: getVendorsSearchResults
      parameters:
        - name: generalLeadId
          in: path
          required: true
          schema:
            type: integer
            format: int64
        - name: categoryId
          in: query
          required: true
          schema:
            type: integer
            format: int64
        - name: cityName
          in: query
          required: false
          schema:
            type: string
        - name: provinceCode
          in: query
          required: false
          schema:
            type: string
        - name: postalCode
          in: query
          required: false
          schema:
            type: string
        - name: minBudget
          in: query
          required: false
          schema:
            type: number
            format: double
        - name: maxBudget
          in: query
          required: false
          schema:
            type: number
            format: double
        - name: use-ai
          in: query
          required: false
          schema:
            type: boolean
            default: true
      responses:
        '200':
          description: Vendor search results
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      pqVendors:
                        type: array
                        items:
                          type: object
                          properties:
                            vendorId:
                              type: integer
                              format: int64
                            vendorName:
                              type: string
                            pqVendor:
                              type: boolean
                            budgetMatch:
                              type: boolean
                            postalCodeMatch:
                              type: boolean
                            similarityScore:
                              type: number
                              format: double
                      nonPqVendors:
                        type: array
                        items:
                          type: object
                          properties:
                            vendorId:
                              type: integer
                              format: int64
                            vendorName:
                              type: string
                            pqVendor:
                              type: boolean
                            budgetMatch:
                              type: boolean
                            postalCodeMatch:
                              type: boolean
                            similarityScore:
                              type: number
                              format: double
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token issued from the RenovationFind Manager Portal

````