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
Customers capabilities
10 capabilities, all acting on a customer. A reference to one from another domain is spelled
customer_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 |
|---|---|---|
| customers.listPOST /api/v1/customers/list | Search the customer book by name, email or phone | read-only |
| customers.getPOST /api/v1/customers/get | Get one customer record by id | read-only |
| customers.find_by_contactPOST /api/v1/customers/find_by_contact | Find a customer by exact phone number or email address | read-only |
| customers.createPOST /api/v1/customers/create | Add a new customer to the shop's book | writes |
| customers.updatePOST /api/v1/customers/update | Change one detail on a customer record | writes |
| customers.record_consentPOST /api/v1/customers/record_consent | Record why this shop may message a customer, and since when | writes |
| customers.list_notesPOST /api/v1/customers/list_notes | Read the internal notes on a customer | read-only |
| customers.add_notePOST /api/v1/customers/add_note | Add an internal note to a customer record | writes |
| customers.consent_standingPOST /api/v1/customers/consent_standing | Check whether this shop may still message a customer, and until when | read-only |
| customers.set_marketing_consentPOST /api/v1/customers/set_marketing_consent | Turn marketing messages to a customer on or off | writes |