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
Reference
Capability index
222 capabilities across 25 domains. Every one is reachable over REST, over MCP, through the Claude connector and from Zapier unless its own page says otherwise — surfaces are opt-out, so a capability appears everywhere by default and has to state where it does not belong.
Published contracts, transports still landing
Every capability below is described from the registry the software runs on, and its schema, its gates and its behaviour are settled. The REST path and the MCP tool name are published now so you can build against them; each capability's own page carries a chip saying whether that transport answers on this deployment yet.
Customers
Acts on a customer. Domain page
| 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 |
Vehicles
Acts on a vehicle. Domain page
| Capability | What it does | Effect |
|---|---|---|
| vehicles.listPOST /api/v1/vehicles/list | List the vehicles in a customer's garage, or across the shop | read-only |
| vehicles.getPOST /api/v1/vehicles/get | Get one vehicle by id | read-only |
| vehicles.find_by_vinPOST /api/v1/vehicles/find_by_vin | Find a vehicle by its VIN | read-only |
| vehicles.createPOST /api/v1/vehicles/create | Add a vehicle to a customer's garage | writes |
| vehicles.updatePOST /api/v1/vehicles/update | Change one detail on a vehicle | writes |
| vehicles.typesPOST /api/v1/vehicles/types | List the vehicle size classes this shop prices by | read-only |
| vehicles.decode_vinPOST /api/v1/vehicles/decode_vin | Decode a VIN into the vehicle's year, make, model and size | read-only |
Leads
Acts on a lead. Domain page
| 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 |
Warranties
Acts on a warranty. Domain page
| Capability | What it does | Effect |
|---|---|---|
| warranties.listPOST /api/v1/warranties/list | Search the warranty registry by customer, expiry or coverage | read-only |
| warranties.expiry_summaryPOST /api/v1/warranties/expiry_summary | Count every warranty by whether it is active, expiring or expired | read-only |
| warranties.certificatePOST /api/v1/warranties/certificate | Read what one warranty certificate actually promises | read-only |
| warranties.claimsPOST /api/v1/warranties/claims | List the comeback claims raised against the shop's warranty work | read-only |
| warranties.claim_insightsPOST /api/v1/warranties/claim_insights | Break the shop's warranty claims down by cause and outcome | read-only |
| warranties.issuePOST /api/v1/warranties/issue | Issue a warranty on a finished job or a paid invoice | writes |
| warranties.claimPOST /api/v1/warranties/claim | Get one warranty claim with its panels and what it cost | read-only |
| warranties.followup_queuePOST /api/v1/warranties/followup_queue | List every warranty still waiting on its validation inspection | read-only |
Quotes
Acts on a quote. Domain page
| Capability | What it does | Effect |
|---|---|---|
| quotes.listPOST /api/v1/quotes/list | List quotes by status, customer or vehicle | read-only |
| quotes.getPOST /api/v1/quotes/get | Get one quote by id, with its totals and dates | read-only |
| quotes.list_linesPOST /api/v1/quotes/list_lines | List the priced lines on a quote | read-only |
| quotes.statusesPOST /api/v1/quotes/statuses | List the statuses a quote can be in | read-only |
| quotes.catalogPOST /api/v1/quotes/catalog | List the services and prices a quote is built from | read-only |
| quotes.send_statusPOST /api/v1/quotes/send_status | Check whether a quote can be sent, and by which channel | read-only |
| quotes.set_statusPOST /api/v1/quotes/set_status | Move a quote to another status | writes |
| quotes.extend_validityPOST /api/v1/quotes/extend_validity | Extend how long a quote's price stays good for | writes |
| quotes.sendPOST /api/v1/quotes/send | Text or email a quote to the customer for approval | writes · reaches the customer |
| quotes.optionsPOST /api/v1/quotes/options | Read the choices and bundle savings offered on one quote | read-only |
Invoices
Acts on a invoice. Domain page
| Capability | What it does | Effect |
|---|---|---|
| invoices.listPOST /api/v1/invoices/list | List invoices by status, customer or how overdue they are | read-only |
| invoices.getPOST /api/v1/invoices/get | Get one whole invoice, its balance and its terms | read-only |
| invoices.agingPOST /api/v1/invoices/aging | Total every unpaid invoice, split by how overdue it is | read-only |
| invoices.statementPOST /api/v1/invoices/statement | Draw one customer's account statement of invoices and payments | read-only |
| invoices.create_from_jobPOST /api/v1/invoices/create_from_job | Raise a draft invoice for the work on one job | writes |
| invoices.create_from_quotePOST /api/v1/invoices/create_from_quote | Raise an invoice from an accepted quote's agreed totals | writes |
| invoices.issuePOST /api/v1/invoices/issue | Issue a draft invoice so the balance becomes owed | writes |
| invoices.sendPOST /api/v1/invoices/send | Send one invoice to the customer with a view-and-pay link | writes · reaches the customer |
| invoices.record_paymentPOST /api/v1/invoices/record_payment | Record money already received against one invoice | writes |
| invoices.voidPOST /api/v1/invoices/void | Void an invoice that should never have been billed | writes |
| invoices.line_itemsPOST /api/v1/invoices/line_items | List what one invoice actually charged for, line by line | read-only |
| invoices.recoveryPOST /api/v1/invoices/recovery | List the customer accounts holding an unpaid invoice balance | read-only |
| invoices.internal_notesPOST /api/v1/invoices/internal_notes | Read the shop's private working notes on one invoice | read-only |
Payments
Acts on a payment. Domain page
| Capability | What it does | Effect |
|---|---|---|
| payments.listPOST /api/v1/payments/list | List payments the shop has taken, by invoice, customer or date | read-only |
| payments.getPOST /api/v1/payments/get | Get one payment record and what is left of it | read-only |
| payments.deposit_statusPOST /api/v1/payments/deposit_status | Check which booked jobs still owe their deposit payment | read-only |
| payments.accepted_methodsPOST /api/v1/payments/accepted_methods | Check which payment methods this shop accepts from a customer | read-only |
| payments.payout_summaryPOST /api/v1/payments/payout_summary | Check the shop's card balance and its recent payments out | read-only |
| payments.tips_collectedPOST /api/v1/payments/tips_collected | Total the gratuities the shop's payments carried in a period | read-only |
| payments.disputesPOST /api/v1/payments/disputes | List the chargebacks disputing payments this shop took | read-only |
| payments.disputePOST /api/v1/payments/dispute | Get the chargeback on one payment and its evidence deadline | read-only |
Services
Acts on a service. Domain page
| Capability | What it does | Effect |
|---|---|---|
| services.listPOST /api/v1/services/list | List the services on the shop's menu and their prices | read-only |
| services.getPOST /api/v1/services/get | Get one service, its price shape and what it needs to run | read-only |
| services.categoriesPOST /api/v1/services/categories | List the categories the shop's services are grouped under | read-only |
| services.tiersPOST /api/v1/services/tiers | Read a service's price and install time per vehicle size | read-only |
| services.createPOST /api/v1/services/create | Add a new service to the shop's menu with its price | writes |
| services.update_pricePOST /api/v1/services/update_price | Change what a service costs, at one vehicle size or overall | writes |
| services.set_onlinePOST /api/v1/services/set_online | Show or hide one service on the public booking page | writes |
| services.price_bookPOST /api/v1/services/price_book | Read the whole service menu with every price in one call | read-only |
Jobs
Acts on a job. Domain page
| Capability | What it does | Effect |
|---|---|---|
| jobs.listPOST /api/v1/jobs/list | List jobs by stage, customer, vehicle or title | read-only |
| jobs.getPOST /api/v1/jobs/get | Get one job by id, with its schedule and clock | read-only |
| jobs.stagesPOST /api/v1/jobs/stages | List the job stages this shop's workflow board runs on | read-only |
| jobs.timelinePOST /api/v1/jobs/timeline | Read what has happened to a job, newest first | read-only |
| jobs.list_servicesPOST /api/v1/jobs/list_services | List the services and add-ons on a job | read-only |
| jobs.set_stagePOST /api/v1/jobs/set_stage | Move a job to another stage on the workflow board | writes · reaches the customer |
| jobs.assignPOST /api/v1/jobs/assign | Assign a job to a staff member, or unassign it | writes |
| jobs.schedulePOST /api/v1/jobs/schedule | Rebook a job to a new start and end time | writes · reaches the customer |
| jobs.set_notesPOST /api/v1/jobs/set_notes | Replace the internal notes on a job | writes |
| jobs.staffPOST /api/v1/jobs/staff | List the staff a job can be assigned to | read-only |
| jobs.panelsPOST /api/v1/jobs/panels | Track panel-by-panel progress on one install job | read-only |
Calendar
Acts on a event. Domain page
| Capability | What it does | Effect |
|---|---|---|
| calendar.dayPOST /api/v1/calendar/day | List every scheduled event on the shop's board for one day | read-only |
| calendar.day_capacityPOST /api/v1/calendar/day_capacity | Check how many events each day holds against the shop's caps | read-only |
| calendar.unscheduledPOST /api/v1/calendar/unscheduled | List live jobs with no calendar event booked in yet | read-only |
Scheduling
Acts on a slot. Domain page
| Capability | What it does | Effect |
|---|---|---|
| scheduling.calendarPOST /api/v1/scheduling/calendar | List the booked appointment slots between two dates, earliest first | read-only |
| scheduling.suggest_slotsPOST /api/v1/scheduling/suggest_slots | Rank the best slot for a job across bays, installers and margin | read-only |
| scheduling.stationsPOST /api/v1/scheduling/stations | List the bays and lifts a slot can be scheduled into | read-only |
| scheduling.time_offPOST /api/v1/scheduling/time_off | List who is off and cannot be given a slot in a window | read-only |
| scheduling.travel_estimatePOST /api/v1/scheduling/travel_estimate | Estimate the drive between two mobile jobs before booking a slot | read-only |
| scheduling.overbooked_daysPOST /api/v1/scheduling/overbooked_days | Find the days already booked past the shop's own slot ceiling | read-only |
| scheduling.readinessPOST /api/v1/scheduling/readiness | Check whether this shop can have a slot scheduled at all | read-only |
Staff
Acts on a staff. Domain page
| Capability | What it does | Effect |
|---|---|---|
| staff.listPOST /api/v1/staff/list | List the staff on the roster, their skills and their workload | read-only |
| staff.getPOST /api/v1/staff/get | Get one staff member's record, availability and live work | read-only |
| staff.certificationsPOST /api/v1/staff/certifications | List which staff hold which certifications and when they lapse | read-only |
| staff.rolesPOST /api/v1/staff/roles | List the roles this shop grants its staff and what each opens | read-only |
| staff.pay_ratesPOST /api/v1/staff/pay_rates | Read what the shop's staff are paid, by rate and by type | read-only |
| staff.timesheetPOST /api/v1/staff/timesheet | Read one week of the shop's staff clock, with hours per person | read-only |
| staff.pay_periodsPOST /api/v1/staff/pay_periods | Read the shop's recent pay periods and what each staff run came to | read-only |
| staff.on_the_clockPOST /api/v1/staff/on_the_clock | List the staff clocked in right now and what they are working on | read-only |
| staff.time_off_requestsPOST /api/v1/staff/time_off_requests | List the time-off requests waiting on a staff manager's answer | read-only |
| staff.archivedPOST /api/v1/staff/archived | List the staff profiles archived out of the working roster | read-only |
| staff.role_matrixPOST /api/v1/staff/role_matrix | List each staff role and exactly what it can open and change | read-only |
Inventory
Acts on a roll. Domain page
| Capability | What it does | Effect |
|---|---|---|
| inventory.rollsPOST /api/v1/inventory/rolls | List the film rolls on the shelf and how much is left on each | read-only |
| inventory.skusPOST /api/v1/inventory/skus | List the products the shop buys rolls and materials in | read-only |
| inventory.stock_levelsPOST /api/v1/inventory/stock_levels | Total the stock left per product across every roll on the shelf | read-only |
| inventory.valuationPOST /api/v1/inventory/valuation | Total what the film rolls on the shelf are worth at cost | read-only |
| inventory.consumptionPOST /api/v1/inventory/consumption | Show what came off the rolls, and which job took it | read-only |
| inventory.purchase_ordersPOST /api/v1/inventory/purchase_orders | List the purchase orders bringing new rolls and stock in | read-only |
| inventory.remnantsPOST /api/v1/inventory/remnants | List the usable offcuts left over from cut film rolls | read-only |
| inventory.purchase_orderPOST /api/v1/inventory/purchase_order | Get one purchase order — every roll ordered, and what landed | read-only |
Comms
Acts on a message. Domain page
| Capability | What it does | Effect |
|---|---|---|
| comms.list_callsPOST /api/v1/comms/list_calls | List calls by date, direction or outcome, with any voicemail message | read-only |
| comms.get_callPOST /api/v1/comms/get_call | Get one call — direction, outcome, duration and voicemail message | read-only |
| comms.list_missed_callsPOST /api/v1/comms/list_missed_calls | List missed calls and any voicemail message the caller left | read-only |
| comms.get_call_recordingPOST /api/v1/comms/get_call_recording | Get a short-lived signed link to a call recording or voicemail message | read-only |
| comms.get_call_transcriptPOST /api/v1/comms/get_call_transcript | Read what was said on a call, word for word — speech, not a message | read-only |
| comms.get_call_analysisPOST /api/v1/comms/get_call_analysis | Read a call's AI summary, sentiment and promises made, not its messages | read-only |
| comms.list_conversationsPOST /api/v1/comms/list_conversations | List inbox conversations with their latest message and unread state | read-only |
| comms.get_conversationPOST /api/v1/comms/get_conversation | Get one conversation: contact, status, assignee and last message time | read-only |
| comms.search_messagesPOST /api/v1/comms/search_messages | Search message text across every conversation in this shop | read-only |
| comms.update_conversationPOST /api/v1/comms/update_conversation | Mark a conversation read, done, pinned or assigned — not its messages | writes |
| comms.block_textingPOST /api/v1/comms/block_texting | Stop this shop texting one contact — the message opt-out switch | writes |
| comms.set_contact_languagePOST /api/v1/comms/set_contact_language | Set the language this contact's messages are translated into | writes |
| comms.list_messagesPOST /api/v1/comms/list_messages | List messages in one thread, or across the shop, newest first | read-only |
| comms.get_messagePOST /api/v1/comms/get_message | Get one message with its delivery status and who sent it | read-only |
| comms.send_messagePOST /api/v1/comms/send_message | Send a text message to one customer of this shop | writes · reaches the customer |
| comms.schedule_messagePOST /api/v1/comms/schedule_message | Queue a text or email message to a customer for a later time | writes · reaches the customer |
| comms.list_scheduled_messagesPOST /api/v1/comms/list_scheduled_messages | List messages queued to send later, soonest first | read-only |
| comms.cancel_scheduled_messagePOST /api/v1/comms/cancel_scheduled_message | Pull a scheduled message back before it is sent | writes |
| comms.list_phone_numbersPOST /api/v1/comms/list_phone_numbers | List the shop's phone numbers — which one calls, which one messages | read-only |
| comms.get_phone_numberPOST /api/v1/comms/get_phone_number | Get one of the shop's numbers: status, role and message sending | read-only |
| comms.resolve_contactPOST /api/v1/comms/resolve_contact | Find the customer a number belongs to, and whether we may message them | read-only |
Tasks
Acts on a task. Domain page
| Capability | What it does | Effect |
|---|---|---|
| tasks.listPOST /api/v1/tasks/list | List the shop's inbox tasks — open, overdue, mine or one thread's | read-only |
| tasks.getPOST /api/v1/tasks/get | Get one task with its thread, customer, job and source message | read-only |
| tasks.assigneesPOST /api/v1/tasks/assignees | List the teammates a task or a thread can be assigned to | read-only |
| tasks.createPOST /api/v1/tasks/create | Create a task, anchored to a conversation, customer, job or message | writes |
| tasks.updatePOST /api/v1/tasks/update | Change exactly one thing about a task — owner, due date or status | writes |
Shop
Acts on a shop. Domain page
| Capability | What it does | Effect |
|---|---|---|
| shop.profilePOST /api/v1/shop/profile | Read the shop's name, timezone, currency, address and booking link | read-only |
| shop.playbookPOST /api/v1/shop/playbook | Read the shop's own playbook for one of its AI agents | read-only |
| shop.business_hoursPOST /api/v1/shop/business_hours | Read the days and hours this shop is open for work | read-only |
| shop.booking_configPOST /api/v1/shop/booking_config | Read how this shop takes bookings, deposits and approvals | read-only |
| shop.brandingPOST /api/v1/shop/branding | Read the shop's logo and accent colour as customers see them | read-only |
| shop.locationsPOST /api/v1/shop/locations | List the other locations in this shop's organization | read-only |
| shop.agentsPOST /api/v1/shop/agents | List this shop's AI agents, which are on and how they send | read-only |
| shop.messaging_configPOST /api/v1/shop/messaging_config | Read whether the shop may text, and inside which hours | read-only |
| shop.planPOST /api/v1/shop/plan | Read the shop's plan, trial state and what it includes | read-only |
| shop.ai_creditsPOST /api/v1/shop/ai_credits | Check how many AI credits this shop has left to spend | read-only |
| shop.setup_progressPOST /api/v1/shop/setup_progress | Check how far this shop is through setting itself up | read-only |
Documents
Acts on a document. Domain page
| 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 |
Knowledge
Acts on a article. Domain page
| Capability | What it does | Effect |
|---|---|---|
| knowledge.listPOST /api/v1/knowledge/list | List the shop-memory articles the shop's AI is grounded on | read-only |
| knowledge.capacityPOST /api/v1/knowledge/capacity | Check how much shop-memory article space this plan allows | read-only |
| knowledge.playbookPOST /api/v1/knowledge/playbook | List the playbook articles the team uses to answer customers | read-only |
| knowledge.groundingPOST /api/v1/knowledge/grounding | Read the article set an AI agent is actually grounded on here | read-only |
| knowledge.briefPOST /api/v1/knowledge/brief | Read the shop's own brief — the article every agent starts from | read-only |
Reports
Acts on a report. Domain page
| Capability | What it does | Effect |
|---|---|---|
| reports.revenuePOST /api/v1/reports/revenue | Read the revenue, profit and margin report for a period | read-only |
| reports.by_servicePOST /api/v1/reports/by_service | Break a period's revenue and margin report down by service | read-only |
| reports.funnelsPOST /api/v1/reports/funnels | Read the lead and quote conversion report for a period | read-only |
| reports.marketingPOST /api/v1/reports/marketing | Read the report of what each lead source cost and returned | read-only |
| reports.installPOST /api/v1/reports/install | Read the installer and film-usage report for a period | read-only |
| reports.job_plPOST /api/v1/reports/job_pl | Read the per-job profit-and-loss report for completed work | read-only |
| reports.slaPOST /api/v1/reports/sla | Read the first-response speed report for the shop's leads | read-only |
| reports.taxPOST /api/v1/reports/tax | Read the sales-tax report of what was charged and collected | read-only |
| reports.dashboardPOST /api/v1/reports/dashboard | Read today's dashboard report — money in, and who is waiting | read-only |
| reports.metricsPOST /api/v1/reports/metrics | Read the whole business report card, metric by metric | read-only |
| reports.insightsPOST /api/v1/reports/insights | List the advisor's report on what to fix in this business | read-only |
| reports.recovered_revenuePOST /api/v1/reports/recovered_revenue | Read the report on money the AI front desk won back | read-only |
Booking
Acts on a booking. Domain page
| Capability | What it does | Effect |
|---|---|---|
| booking.servicesPOST /api/v1/booking/services | List the services this shop takes online bookings for, with prices | read-only |
| booking.deposit_policyPOST /api/v1/booking/deposit_policy | Check the price and the deposit a booking would require | read-only |
| booking.availabilityPOST /api/v1/booking/availability | List the open appointment times for a booking, day by day | read-only |
| booking.holdPOST /api/v1/booking/hold | Reserve a slot for a few minutes before taking the booking | writes |
| booking.bookPOST /api/v1/booking/book | Take a booking for a customer at a chosen appointment time | writes · reaches the customer |
| booking.getPOST /api/v1/booking/get | Read one booking back by its manage token | read-only |
| booking.reschedulePOST /api/v1/booking/reschedule | Move an existing booking to a different time | writes · reaches the customer |
| booking.cancelPOST /api/v1/booking/cancel | Cancel a booking, after the customer verifies with a code | writes · reaches the customer |
| booking.shop_infoPOST /api/v1/booking/shop_info | Read the opening hours and contact details for a booking caller | read-only |
| booking.addonsPOST /api/v1/booking/addons | List the paid extras sold alongside a booking, with their prices | read-only |
| booking.locationsPOST /api/v1/booking/locations | List the branches of this business taking booking, and where | read-only |
| booking.approval_queuePOST /api/v1/booking/approval_queue | Count the booking requests waiting for the shop to say yes | read-only |
Forms
Acts on a form. Domain page
| Capability | What it does | Effect |
|---|---|---|
| forms.listPOST /api/v1/forms/list | List the shop's lead forms and how many have been submitted | read-only |
| forms.getPOST /api/v1/forms/get | Get one lead form, its steps and what each one asks for | read-only |
| forms.funnelPOST /api/v1/forms/funnel | Show where visitors give up on one lead form, step by step | read-only |
| forms.connectionsPOST /api/v1/forms/connections | List the third-party forms posting straight into this pipeline | read-only |
| forms.templatesPOST /api/v1/forms/templates | List the starter templates a new lead form can be built from | read-only |
Marketing
Acts on a campaign. Domain page
| Capability | What it does | Effect |
|---|---|---|
| marketing.offersPOST /api/v1/marketing/offers | List the discount campaigns running on the shop's booking page | read-only |
| marketing.ad_campaignsPOST /api/v1/marketing/ad_campaigns | List the shop's imported ad campaigns and their current settings | read-only |
| marketing.ad_spendPOST /api/v1/marketing/ad_spend | Total what each ad campaign spent, and what it brought back | read-only |
| marketing.share_link_activityPOST /api/v1/marketing/share_link_activity | Track which links a campaign or quote sent, and who opened them | read-only |
| marketing.reactivation_configPOST /api/v1/marketing/reactivation_config | Read the rules the automatic win-back campaign texts under | read-only |
Reviews
Acts on a review. Domain page
| Capability | What it does | Effect |
|---|---|---|
| reviews.listPOST /api/v1/reviews/list | List the shop's public reviews and which are still unanswered | read-only |
| reviews.getPOST /api/v1/reviews/get | Get one public review, its text and the shop's reply | read-only |
| reviews.insightsPOST /api/v1/reviews/insights | Read the shop's review score, response rate and overdue replies | read-only |
| reviews.ask_funnelPOST /api/v1/reviews/ask_funnel | Measure how many review asks turned into actual reviews | read-only |
| reviews.unreviewed_asksPOST /api/v1/reviews/unreviewed_asks | List customers asked for a review who never left one | read-only |
| reviews.private_feedbackPOST /api/v1/reviews/private_feedback | Read the private ratings customers gave without posting a review | read-only |
| reviews.postsPOST /api/v1/reviews/posts | List the posts the shop published beside its reviews on Google | read-only |
| reviews.replyPOST /api/v1/reviews/reply | Publish the shop's reply to one public review | writes |
| reviews.requestPOST /api/v1/reviews/request | Text one customer asking them to leave the shop a review | writes · reaches the customer |
| reviews.for_customerPOST /api/v1/reviews/for_customer | Find what one customer has said in ratings and public reviews | read-only |
| reviews.settingsPOST /api/v1/reviews/settings | Read how this shop asks for reviews and routes the unhappy ones | read-only |
Automations
Acts on a automation. Domain page
| Capability | What it does | Effect |
|---|---|---|
| automations.listPOST /api/v1/automations/list | List the shop's automation rules and which are armed | read-only |
| automations.activityPOST /api/v1/automations/activity | Show what the shop's automations actually did, and to whom | read-only |
| automations.templatesPOST /api/v1/automations/templates | List the automation templates a shop could switch on | read-only |
| automations.coveragePOST /api/v1/automations/coverage | Find the moments where no automation tells anybody anything | read-only |
| automations.getPOST /api/v1/automations/get | Read one automation step by step — what it sends, and when | read-only |
Integrations
Acts on a connection. Domain page
| Capability | What it does | Effect |
|---|---|---|
| integrations.listPOST /api/v1/integrations/list | List every connection this shop has linked, and to what | read-only |
| integrations.healthPOST /api/v1/integrations/health | Check whether the shop's connections are still working | read-only |
| integrations.availablePOST /api/v1/integrations/available | List the connections this shop could link, and what each does | read-only |