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
Documents capabilities
8 capabilities, all acting on a document. A reference to one from another domain is spelled
document_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 |
|---|---|---|
| documents.listPOST /api/v1/documents/list | Search the shop's document library by title, kind or tag | read-only |
| documents.getPOST /api/v1/documents/get | Get one document's details and what happened to it | read-only |
| documents.for_recordPOST /api/v1/documents/for_record | List the documents filed against one customer, job or vehicle | read-only |
| documents.signature_requestsPOST /api/v1/documents/signature_requests | Check which signature documents are signed, sent or waiting | read-only |
| documents.readinessPOST /api/v1/documents/readiness | Check whether a job's signing document has everything it needs | read-only |
| documents.timelinePOST /api/v1/documents/timeline | Read what has happened to one document — sent, opened, signed | read-only |
| documents.signaturePOST /api/v1/documents/signature | Check who signed a document and whether the file still matches | read-only |
| documents.library_statsPOST /api/v1/documents/library_stats | Count what is in the document library and the tags in use | read-only |