# RenovationFind API

## Docs

- [Generate AI detailed project description](https://docs.renovationfind.com/api-reference/ai-tools/generate-ai-detailed-project-description.md)
- [Add business location](https://docs.renovationfind.com/api-reference/business-locations/add-business-location.md)
- [Delete business location](https://docs.renovationfind.com/api-reference/business-locations/delete-business-location.md)
- [List business locations](https://docs.renovationfind.com/api-reference/business-locations/list-business-locations.md)
- [Get vendor's category assignments](https://docs.renovationfind.com/api-reference/categories/get-vendors-category-assignments.md): Returns all category assignments for a vendor across five lists: active categories, pending categories (with PQ settings), discount categories, wait list categories, and wait list discount categories.
- [List all trade categories](https://docs.renovationfind.com/api-reference/categories/list-all-trade-categories.md): Returns all trade categories (parent + sub-categories) in the system.
- [Batch import customer feedback requests](https://docs.renovationfind.com/api-reference/customer-feedback/batch-import-customer-feedback-requests.md): Import multiple customer feedback requests at once (1-1500 per call). Requests are queued with PENDING delivery status and sent in the next batch cycle (daily at 5:25 PM).
- [Check for duplicates](https://docs.renovationfind.com/api-reference/customer-feedback/check-for-duplicates.md): Check whether a customer feedback request with the given email or phone already exists for this vendor. At least one of `email` or `phone` must be provided.
- [Create a customer feedback request](https://docs.renovationfind.com/api-reference/customer-feedback/create-a-customer-feedback-request.md): Create a single customer feedback request. Sends an email and/or SMS notification to the customer requesting feedback.
- [Get feedback statistics](https://docs.renovationfind.com/api-reference/customer-feedback/get-feedback-statistics.md): Get comprehensive customer feedback statistics for the authenticated vendor, including completion rates, review platform breakdown, referral stats, and monthly trends.
- [List customer feedback requests](https://docs.renovationfind.com/api-reference/customer-feedback/list-customer-feedback-requests.md): Retrieve a paginated list of customer feedback requests for the authenticated vendor. Supports filtering by status.
- [Check for duplicates](https://docs.renovationfind.com/api-reference/feedback-requests/check-for-duplicates.md): Check whether a feedback request with the given email or phone already exists for this vendor. At least one of `email` or `phone` must be provided.
- [Create a feedback request](https://docs.renovationfind.com/api-reference/feedback-requests/create-a-feedback-request.md): Create a single standalone feedback request. Sends an email and/or SMS notification to the customer requesting feedback. Requires the `enableStandaloneFeedbackBooster` feature to be enabled.
- [Get feedback KPIs](https://docs.renovationfind.com/api-reference/feedback-requests/get-feedback-kpis.md): Get key performance indicators for standalone feedback requests for the authenticated vendor.
- [List feedback requests](https://docs.renovationfind.com/api-reference/feedback-requests/list-feedback-requests.md): Retrieve a paginated list of standalone feedback requests for the authenticated vendor. Supports filtering by request type and source. Requires the `enableStandaloneFeedbackBooster` feature to be enabled.
- [Add a comment to a general lead](https://docs.renovationfind.com/api-reference/general-lead-comments/add-a-comment-to-a-general-lead.md)
- [Delete a comment](https://docs.renovationfind.com/api-reference/general-lead-comments/delete-a-comment.md)
- [Update a comment](https://docs.renovationfind.com/api-reference/general-lead-comments/update-a-comment.md)
- [Create a customer communication](https://docs.renovationfind.com/api-reference/general-lead-communications/create-a-customer-communication.md)
- [Delete a communication attachment](https://docs.renovationfind.com/api-reference/general-lead-communications/delete-a-communication-attachment.md)
- [Get communications for a general lead](https://docs.renovationfind.com/api-reference/general-lead-communications/get-communications-for-a-general-lead.md)
- [Send manual status update to vendor](https://docs.renovationfind.com/api-reference/general-lead-communications/send-manual-status-update-to-vendor.md)
- [Send vendor communications](https://docs.renovationfind.com/api-reference/general-lead-communications/send-vendor-communications.md)
- [Take action on a communication](https://docs.renovationfind.com/api-reference/general-lead-communications/take-action-on-a-communication.md)
- [Update post-acceptance non-status fields](https://docs.renovationfind.com/api-reference/general-lead-communications/update-post-acceptance-non-status-fields.md)
- [Update post-acceptance status](https://docs.renovationfind.com/api-reference/general-lead-communications/update-post-acceptance-status.md)
- [Upload communication attachments](https://docs.renovationfind.com/api-reference/general-lead-communications/upload-communication-attachments.md): Upload up to 10 files per request. Max 10MB per file.
- [Accept a lead](https://docs.renovationfind.com/api-reference/general-leads/accept-a-lead.md): Accept a vendor-assigned lead. Triggers a customer notification informing them of your acceptance. The lead must not have been previously accepted or declined. After acceptance, customer contact information becomes visible in the lead details.
- [Create a general lead](https://docs.renovationfind.com/api-reference/general-leads/create-a-general-lead.md): Creates a new general lead. At least one of email or phone is required.
- [Decline a lead](https://docs.renovationfind.com/api-reference/general-leads/decline-a-lead.md): Decline a vendor-assigned lead with a reason. The lead must not have been previously accepted or declined.
- [Delete a general lead](https://docs.renovationfind.com/api-reference/general-leads/delete-a-general-lead.md)
- [Delete an attachment](https://docs.renovationfind.com/api-reference/general-leads/delete-an-attachment.md): Delete a single file attachment from a lead.
- [Download an attachment](https://docs.renovationfind.com/api-reference/general-leads/download-an-attachment.md): Download or preview a file attachment. Returns the file with its original content type.
- [Get filter badge counts](https://docs.renovationfind.com/api-reference/general-leads/get-filter-badge-counts.md): Get the count of leads for each filter category (all, accepted, requires attention). Useful for dashboard badges.
- [Get general lead details](https://docs.renovationfind.com/api-reference/general-leads/get-general-lead-details.md)
- [Get general lead stats](https://docs.renovationfind.com/api-reference/general-leads/get-general-lead-stats.md)
- [Get lead details](https://docs.renovationfind.com/api-reference/general-leads/get-lead-details.md): Get full details of a single vendor-assigned lead. Automatically marks the lead as viewed. Customer contact information (email, phone, address) is only included if the lead has been accepted.
- [Get previous leads from the same customer](https://docs.renovationfind.com/api-reference/general-leads/get-previous-leads-from-the-same-customer.md)
- [List general leads](https://docs.renovationfind.com/api-reference/general-leads/list-general-leads.md): Paginated list of general leads with optional filtering by view, filter, and search query. Maximum page size is 50.
- [List vendor-assigned leads](https://docs.renovationfind.com/api-reference/general-leads/list-vendor-assigned-leads.md): Retrieve a paginated list of leads assigned to the authenticated vendor. Supports filtering by status. Leads are assigned by the RenovationFind team.
- [Search vendors for a general lead](https://docs.renovationfind.com/api-reference/general-leads/search-vendors-for-a-general-lead.md): Searches for matching vendors by category, with optional postal code and city/province filtering. Results include budget match info and optional AI similarity scoring.
- [Update a general lead](https://docs.renovationfind.com/api-reference/general-leads/update-a-general-lead.md)
- [Update detailed project description](https://docs.renovationfind.com/api-reference/general-leads/update-detailed-project-description.md): Updates the detailed project description for a general lead. Maximum 10,000 characters.
- [Update essential info and generate AI project description](https://docs.renovationfind.com/api-reference/general-leads/update-essential-info-and-generate-ai-project-description.md): Updates essential info (customer name, email, phone, address, project info, etc.) and triggers AI-generated detailed project description.
- [Update general lead customer details](https://docs.renovationfind.com/api-reference/general-leads/update-general-lead-customer-details.md)
- [Update general lead details](https://docs.renovationfind.com/api-reference/general-leads/update-general-lead-details.md)
- [Update general lead location details](https://docs.renovationfind.com/api-reference/general-leads/update-general-lead-location-details.md)
- [Update general lead payment details](https://docs.renovationfind.com/api-reference/general-leads/update-general-lead-payment-details.md)
- [Update general lead RenovationFind type](https://docs.renovationfind.com/api-reference/general-leads/update-general-lead-renovationfind-type.md)
- [Update general lead status](https://docs.renovationfind.com/api-reference/general-leads/update-general-lead-status.md)
- [Update general lead vendor details](https://docs.renovationfind.com/api-reference/general-leads/update-general-lead-vendor-details.md)
- [Update job status](https://docs.renovationfind.com/api-reference/general-leads/update-job-status.md): Update the post-acceptance job status for a lead. The lead must have been accepted first. Once status is set to `JOB_WON` or `LEAD_WON`, it cannot be changed (contact support to update).
- [Update PQ lead status](https://docs.renovationfind.com/api-reference/general-leads/update-pq-lead-status.md)
- [Update require-action flag on a general lead](https://docs.renovationfind.com/api-reference/general-leads/update-require-action-flag-on-a-general-lead.md)
- [Upload file attachments](https://docs.renovationfind.com/api-reference/general-leads/upload-file-attachments.md): Upload file attachments for a lead. Only allowed when the post-acceptance status is `JOB_WON` or `LEAD_WON`. Accepted file types: PDF, JPG, PNG. Maximum 10MB per file, 10 files per request.
- [List all provinces/states](https://docs.renovationfind.com/api-reference/reference-data/list-all-provincesstates.md): Returns all provinces and states with their codes and country. Useful for populating location dropdowns and filtering cities.
- [List cities](https://docs.renovationfind.com/api-reference/reference-data/list-cities.md): Returns cities with province info. Optionally filter by province. Does NOT include lat/long or service boundaries — use `/cities/{cityId}/service-boundaries` for that.
- [List service boundaries for a city](https://docs.renovationfind.com/api-reference/reference-data/list-service-boundaries-for-a-city.md): Returns service boundaries available for the specified city. Each boundary has an id, name, urlPath, and cityName. Does NOT include GeoJSON polygon data or coordinates.
- [Batch import referral requests](https://docs.renovationfind.com/api-reference/referral-requests/batch-import-referral-requests.md): Import multiple referral requests at once. Requires the `enableStandaloneReferralBooster` feature to be enabled.
- [Check for duplicates](https://docs.renovationfind.com/api-reference/referral-requests/check-for-duplicates.md): Check whether a referral request with the given email or phone already exists for this vendor. At least one of `email` or `phone` must be provided.
- [Create a referral request](https://docs.renovationfind.com/api-reference/referral-requests/create-a-referral-request.md): Create a single standalone referral request. Sends an email and/or SMS notification to the customer requesting a referral. Requires the `enableStandaloneReferralBooster` feature to be enabled.
- [Get referral KPIs](https://docs.renovationfind.com/api-reference/referral-requests/get-referral-kpis.md): Get key performance indicators for standalone referral requests for the authenticated vendor.
- [List referral requests](https://docs.renovationfind.com/api-reference/referral-requests/list-referral-requests.md): Retrieve a paginated list of standalone referral requests for the authenticated vendor. Supports filtering by source and send status. Requires the `enableStandaloneReferralBooster` feature to be enabled.
- [Check for duplicates](https://docs.renovationfind.com/api-reference/reputation-process/check-for-duplicates.md): Check whether a reputation process with the given email or phone already exists for this vendor. At least one of `email` or `phone` must be provided. Requires the `enableFullRMS` feature to be enabled.
- [Create a reputation process request](https://docs.renovationfind.com/api-reference/reputation-process/create-a-reputation-process-request.md): Create a single reputation process request. Sends notifications to the customer initiating the full reputation management workflow. Requires the `enableFullRMS` feature to be enabled.
- [Delete a reputation process](https://docs.renovationfind.com/api-reference/reputation-process/delete-a-reputation-process.md): Delete a reputation process by ID. Requires the `enableFullRMS` feature to be enabled.
- [Get reputation process KPIs](https://docs.renovationfind.com/api-reference/reputation-process/get-reputation-process-kpis.md): Get key performance indicators for reputation processes for the authenticated vendor. Requires the `enableFullRMS` feature to be enabled.
- [List reputation processes](https://docs.renovationfind.com/api-reference/reputation-process/list-reputation-processes.md): Retrieve a paginated list of reputation processes for the authenticated vendor. Supports filtering by status. Requires the `enableFullRMS` feature to be enabled.
- [Stop a reputation process](https://docs.renovationfind.com/api-reference/reputation-process/stop-a-reputation-process.md): Stop an active reputation process by ID. Requires the `enableFullRMS` feature to be enabled.
- [List all required document types](https://docs.renovationfind.com/api-reference/required-documents/list-all-required-document-types.md): Returns the master list of required document types in the system.
- [List vendor's required documents](https://docs.renovationfind.com/api-reference/required-documents/list-vendors-required-documents.md): Returns the required documents assigned to this vendor with their status.
- [Check for duplicates](https://docs.renovationfind.com/api-reference/review-requests/check-for-duplicates.md): Check whether a review request with the given email or phone already exists for this vendor. At least one of `email` or `phone` must be provided.
- [Create a review request](https://docs.renovationfind.com/api-reference/review-requests/create-a-review-request.md): Create a single standalone review request. Sends an email and/or SMS notification to the customer requesting a review. Requires the `enableStandaloneReviewBooster` feature to be enabled.
- [Get review KPIs](https://docs.renovationfind.com/api-reference/review-requests/get-review-kpis.md): Get key performance indicators for standalone review requests for the authenticated vendor.
- [List review requests](https://docs.renovationfind.com/api-reference/review-requests/list-review-requests.md): Retrieve a paginated list of standalone review requests for the authenticated vendor. Supports filtering by source. Requires the `enableStandaloneReviewBooster` feature to be enabled.
- [Get vendor review settings](https://docs.renovationfind.com/api-reference/review-settings/get-vendor-review-settings.md): Returns review platform configuration, custom messages, primary Google label, and additional Google review locations (max 5).
- [Update vendor review settings](https://docs.renovationfind.com/api-reference/review-settings/update-vendor-review-settings.md): Updates review platform enablement, custom SMS/email messages, primary Google review label, and additional Google review locations (max 5).
- [Get vendor service boundaries](https://docs.renovationfind.com/api-reference/service-boundaries/get-vendor-service-boundaries.md)
- [List available service boundaries](https://docs.renovationfind.com/api-reference/service-boundaries/list-available-service-boundaries.md): Lists all service boundaries, optionally filtered by city ID.
- [Set vendor service boundaries](https://docs.renovationfind.com/api-reference/service-boundaries/set-vendor-service-boundaries.md): Replaces the vendor's service boundaries with the provided list of boundary IDs. Send an empty list to clear all boundaries. Maximum 100 boundaries per vendor.
- [Update email template](https://docs.renovationfind.com/api-reference/settings/update-email-template.md): Update the custom email message sent to customers when a customer feedback request is created. Max 2000 characters.
- [Update SMS template](https://docs.renovationfind.com/api-reference/settings/update-sms-template.md): Update the custom SMS message sent to customers when a customer feedback request is created. Max 500 characters.
- [Update workflow settings](https://docs.renovationfind.com/api-reference/settings/update-workflow-settings.md): Update the customer feedback workflow configuration. Controls which steps (feedback, review, referral) are included in the customer experience.
- [Create blog entry](https://docs.renovationfind.com/api-reference/vendor-blog-entries/create-blog-entry.md)
- [Delete blog entry](https://docs.renovationfind.com/api-reference/vendor-blog-entries/delete-blog-entry.md)
- [List vendor blog entries](https://docs.renovationfind.com/api-reference/vendor-blog-entries/list-vendor-blog-entries.md)
- [Get contest settings](https://docs.renovationfind.com/api-reference/vendor-contests/get-contest-settings.md): Get the vendor's contest settings including sync status and pause flags. Requires the `enableVendorContests` feature to be enabled.
- [Get contest statistics](https://docs.renovationfind.com/api-reference/vendor-contests/get-contest-statistics.md): Get comprehensive vendor contest statistics including uploads, conversions, referrals, FB shares, opt-outs, and source breakdown (Full RMS Drip vs standalone import). Requires the `enableVendorContests` feature to be enabled.
- [Import contest participants](https://docs.renovationfind.com/api-reference/vendor-contests/import-contest-participants.md): Upload a CSV or Excel file to batch-import contest participants. Processing is asynchronous — you receive a success response once the file is accepted.
- [List contest participants](https://docs.renovationfind.com/api-reference/vendor-contests/list-contest-participants.md): Retrieve a paginated list of contest participants for the authenticated vendor. Includes journey data (conversions, referrals, FB shares, opt-outs). Requires the `enableVendorContests` feature to be enabled.
- [Sync CFS records to contests](https://docs.renovationfind.com/api-reference/vendor-contests/sync-cfs-records-to-contests.md): Trigger a sync of Customer Feedback System (Full RMS Drip) records into the vendor contest pipeline. This is an asynchronous operation — returns immediately after initiating the sync. Returns `200 OK` if there are no unsynced records to process. Returns `409 Conflict` if a sync is already in progres…
- [Update contest settings](https://docs.renovationfind.com/api-reference/vendor-contests/update-contest-settings.md): Update vendor contest settings. Currently supports toggling pause flags: - `PAUSE_CURRENT_DRIPS_IN_PIPELINE` — pause notifications for existing participants in the drip pipeline - `PAUSE_VENDOR_CONTEST_DRIPPING_FROM_CFS` — pause new CFS records from being added to contests
- [Add tag to gallery image](https://docs.renovationfind.com/api-reference/vendor-gallery/add-tag-to-gallery-image.md)
- [Change gallery image priority](https://docs.renovationfind.com/api-reference/vendor-gallery/change-gallery-image-priority.md): Reorder a gallery image by specifying old and new 1-indexed positions.
- [Delete gallery image](https://docs.renovationfind.com/api-reference/vendor-gallery/delete-gallery-image.md)
- [Enable or disable gallery image](https://docs.renovationfind.com/api-reference/vendor-gallery/enable-or-disable-gallery-image.md)
- [List gallery images](https://docs.renovationfind.com/api-reference/vendor-gallery/list-gallery-images.md)
- [Remove tag from gallery image](https://docs.renovationfind.com/api-reference/vendor-gallery/remove-tag-from-gallery-image.md)
- [Update gallery image caption and description](https://docs.renovationfind.com/api-reference/vendor-gallery/update-gallery-image-caption-and-description.md)
- [Upload gallery image](https://docs.renovationfind.com/api-reference/vendor-gallery/upload-gallery-image.md): Upload multipart with files[], maxWidth (900), maxHeight (700).
- [Delete ad image](https://docs.renovationfind.com/api-reference/vendor-images/delete-ad-image.md)
- [Delete cover image](https://docs.renovationfind.com/api-reference/vendor-images/delete-cover-image.md)
- [Delete discount image](https://docs.renovationfind.com/api-reference/vendor-images/delete-discount-image.md)
- [Delete Google rank image](https://docs.renovationfind.com/api-reference/vendor-images/delete-google-rank-image.md)
- [Get ad image](https://docs.renovationfind.com/api-reference/vendor-images/get-ad-image.md)
- [Get cover image](https://docs.renovationfind.com/api-reference/vendor-images/get-cover-image.md)
- [Get discount image](https://docs.renovationfind.com/api-reference/vendor-images/get-discount-image.md)
- [Get Google rank image](https://docs.renovationfind.com/api-reference/vendor-images/get-google-rank-image.md)
- [Upload ad image](https://docs.renovationfind.com/api-reference/vendor-images/upload-ad-image.md): Upload multipart with files[], maxWidth (900), maxHeight (700).
- [Upload cover image](https://docs.renovationfind.com/api-reference/vendor-images/upload-cover-image.md): Upload multipart with files[], maxWidth (1920), maxHeight (600).
- [Upload discount image](https://docs.renovationfind.com/api-reference/vendor-images/upload-discount-image.md): Upload multipart with files[], maxWidth (900), maxHeight (700).
- [Upload Google rank image](https://docs.renovationfind.com/api-reference/vendor-images/upload-google-rank-image.md): Upload multipart with files[], maxWidth (900), maxHeight (700).
- [Delete vendor logo](https://docs.renovationfind.com/api-reference/vendor-logo/delete-vendor-logo.md)
- [Get vendor logo](https://docs.renovationfind.com/api-reference/vendor-logo/get-vendor-logo.md)
- [Upload vendor logo](https://docs.renovationfind.com/api-reference/vendor-logo/upload-vendor-logo.md): Upload a new logo image. Accepts jpg, jpeg, gif, png. You must include `maxWidth` and `maxHeight` as form fields — always use **900** and **700** respectively to match standard logo dimensions.
- [Update subscription details](https://docs.renovationfind.com/api-reference/vendor-subscription/update-subscription-details.md): Update vendor package type and subscription end date. Only works when subscription auto-renew is not active.
- [Create a new vendor](https://docs.renovationfind.com/api-reference/vendors/create-a-new-vendor.md): Create a new vendor account. Requires vendorName, email, password, salesEmail, and cityId. Optional fields include contact details, description, and flags. Email must be unique. Password is securely hashed before storage.
- [Get vendor details](https://docs.renovationfind.com/api-reference/vendors/get-vendor-details.md): Retrieve the full profile for a single vendor, including all sections: account, contact, city, social, descriptions, features, compliance, pre-qualified settings, discount, subscription, and contests.
- [Reset vendor password](https://docs.renovationfind.com/api-reference/vendors/reset-vendor-password.md): Reset the password for a vendor account. The new password is required and cannot be empty.
- [Search vendors](https://docs.renovationfind.com/api-reference/vendors/search-vendors.md): Search for vendors by name or ID. Returns a paginated list of matching vendors with basic profile information.
- [Update account fields](https://docs.renovationfind.com/api-reference/vendors/update-account-fields.md): Update account-level fields for a vendor. All fields are optional; only provided (non-null) fields are applied.
- [Update compliance fields](https://docs.renovationfind.com/api-reference/vendors/update-compliance-fields.md): Update compliance and certification fields for a vendor. All fields are optional; only provided (non-null) fields are applied. Date fields use `dd/MM/yyyy` format.
- [Update contact fields](https://docs.renovationfind.com/api-reference/vendors/update-contact-fields.md): Update contact information for a vendor. All fields are optional; only provided (non-null) fields are applied.
- [Update contest settings](https://docs.renovationfind.com/api-reference/vendors/update-contest-settings.md): Update vendor contest settings (stored in VendorExtraData). All fields are optional; only provided (non-null) fields are applied.
- [Update descriptions](https://docs.renovationfind.com/api-reference/vendors/update-descriptions.md): Update vendor profile descriptions (about, services, areas served, etc.). All fields are optional; only provided (non-null) fields are applied.
- [Update discount settings](https://docs.renovationfind.com/api-reference/vendors/update-discount-settings.md): Update discount program settings for a vendor. All fields are optional; only provided (non-null) fields are applied.
- [Update feature flags](https://docs.renovationfind.com/api-reference/vendors/update-feature-flags.md): Update feature flags for a vendor (e.g. RMS, boosters, lead booster). All fields are optional; only provided (non-null) fields are applied.
- [Update pre-qualified settings](https://docs.renovationfind.com/api-reference/vendors/update-pre-qualified-settings.md): Update pre-qualified (PQ) vendor settings. All fields are optional; only provided (non-null) fields are applied.
- [Update social links](https://docs.renovationfind.com/api-reference/vendors/update-social-links.md): Update social media and website URLs for a vendor. All fields are optional; only provided (non-null) fields are applied.
- [Update subscription](https://docs.renovationfind.com/api-reference/vendors/update-subscription.md): Update subscription fields for a vendor. All fields are optional; only provided (non-null) fields are applied. Date fields use `dd/MM/yyyy` format.
- [Authentication](https://docs.renovationfind.com/authentication.md): How to authenticate with the RenovationFind API
- [Authentication](https://docs.renovationfind.com/internal-api/authentication.md): How to authenticate with the RenovationFind Internal Manager API
- [Introduction](https://docs.renovationfind.com/internal-api/introduction.md): Getting started with the RenovationFind Internal Manager API
- [Introduction](https://docs.renovationfind.com/introduction.md): Getting started with the RenovationFind API
- [Welcome](https://docs.renovationfind.com/welcome.md): RenovationFind documentation and resources

## OpenAPI Specs

- [openapi](https://docs.renovationfind.com/openapi.yaml)
- [openapi-manager](https://docs.renovationfind.com/openapi-manager.yaml)