Documentation
Service VIN developer & AI platformGetting startedAuthenticationPaginationIdempotencyRate limitsErrorsWebhooks & signature verificationConnecting ClaudeRecipesMCP servers & the Claude connectorREST resource referenceCapability indexCustomers capabilitiesVehicles capabilitiesLeads capabilitiesWarranties capabilitiesQuotes capabilitiesInvoices capabilitiesPayments capabilitiesServices capabilitiesJobs capabilitiesCalendar capabilitiesScheduling capabilitiesStaff capabilitiesInventory capabilitiesComms capabilitiesTasks capabilitiesShop capabilitiesDocuments capabilitiesKnowledge capabilitiesReports capabilitiesBooking capabilitiesForms capabilitiesMarketing capabilitiesReviews capabilitiesAutomations capabilitiesIntegrations capabilitiesChangelogSearch
Domain
Leads capabilities
15 capabilities, all acting on a lead. A reference to one from another domain is spelled
lead_id — never a bare id — and every one of those fields names the capability that produces it, so a model can chain calls without guessing.| Capability | What it does | Effect |
|---|---|---|
| leads.listPOST /api/v1/leads/list | Search the lead pipeline by name, status, owner or source | read-only |
| leads.getPOST /api/v1/leads/get | Get one whole lead record by id | read-only |
| leads.statusesPOST /api/v1/leads/statuses | List the statuses a lead can be moved through | read-only |
| leads.assigneesPOST /api/v1/leads/assignees | List the teammates a lead can be assigned to | read-only |
| leads.sourcesPOST /api/v1/leads/sources | Break the shop's leads down by where they came from | read-only |
| leads.intake_healthPOST /api/v1/leads/intake_health | Check whether every rail is still delivering leads | read-only |
| leads.find_duplicatesPOST /api/v1/leads/find_duplicates | Find other leads that look like the same person | read-only |
| leads.createPOST /api/v1/leads/create | Add a new lead to the shop's pipeline | writes · reaches the customer |
| leads.updatePOST /api/v1/leads/update | Change one detail on a lead record | writes |
| leads.set_statusPOST /api/v1/leads/set_status | Move one lead to a different pipeline status | writes · reaches the customer |
| leads.assignPOST /api/v1/leads/assign | Give one lead to a teammate, or take its owner off | writes |
| leads.add_notePOST /api/v1/leads/add_note | Put a note on one lead's timeline | writes |
| leads.unansweredPOST /api/v1/leads/unanswered | List the open leads nobody has replied to yet, oldest first | read-only |
| leads.missed_intakePOST /api/v1/leads/missed_intake | List the enquiries that arrived but never became a lead | read-only |
| leads.convert_to_customerPOST /api/v1/leads/convert_to_customer | Turn a lead into a customer record with its vehicle | writes |