API reference

Every operation in this reference has its own page. The pages are generated from a saved copy of the core's operation list.

Sign-in and agent access

OperationWhat it doesWho
auth.requestLinkEmail a one-time sign-in linkAgents can call this
auth.redeemLinkExchange a sign-in link token for a browser sessionHosted page only
auth.oauthRegisterRegister an OAuth client (RFC 7591 dynamic registration)Agents can call this
auth.oauthAuthorizeA signed-in person approves an agent clientAgents can call this
auth.oauthTokenExchange an authorization code and PKCE verifier, or a refresh token, for a short-lived agent access token and a new refresh tokenAgents can call this
me.getThe signed-in personAgents can call this
keys.createMake a named agent key for one shop (owner only)A person's own sign-in only
keys.listList a shop's named agent keys (owner only): label, scopes, audience, when made, last used (last_used_at, to the minute; null and never_used true if the key was never used) and revokedAgents can call this
keys.revokeRevoke a named agent key (owner only)Agents can call this
keys.connectionsList every outside agent connected to the shop through OAuth (owner only): which worker connected it, the client name, whether it reaches only this shop or all of that worker's shops, scopes, when connected, last used and revokedAgents can call this
keys.revokeConnectionRevoke an outside agent a worker connected through OAuth (owner only)Agents can call this
agents.registerPreferred when you know the owner's email: type service_auth and login_hintAgents can call this
agents.claimauth.md claimAgents can call this
agents.approveHosted claim page only: the shop owner whose email the claim names types the agent's 6 digit code, picks one of their shops and accepts the agent key termsHosted page only
agents.denyHosted claim page only: the person turns the agent downHosted page only
legal.documentsThe legal documents Doing Work asks people to accept, with the current version and a link to the textAgents can call this
legal.statusWhat the signed-in person has accepted: for each document that is accepted here, the current version, the versions accepted and when, and whether the current version still needs acceptingAgents can call this
legal.acceptRecord that the signed-in person accepts the current version of a legal document (clickwrap)A person's own sign-in only
legal.shopTermsFor one shop: the current Terms of Service version, whether the owner accepted it for the shop, when we emailed the owner the terms (shops an agent signed up), and the section 19 arbitration opt-out window, deadline and statusAgents can call this
legal.acceptShopTermsThe shop owner, on the hosted shop terms page, ticks the box and accepts the current Terms of Service for the shop (accept_terms_version)Hosted page only
legal.arbitrationOptOutThe shop owner, on the hosted shop terms page, opts the shop out of section 19 arbitration and the class action waiverHosted page only

Shop

OperationWhat it doesWho
auth.sendLinkEmail a person a one-time sign-in link that opens a named Doing Work screen after they sign in, so an agent can hand its person straight to the page that needs a human (brand, terms, job photos and so on)Agents can call this
me.startStart hereAgents can call this
me.shopsShops the signed-in person belongs to right now, with their roleAgents can call this
shops.createCreate a shopAgents can call this
members.resendInviteEmail an open invite again with a new link, for a worker or office member who lost it or let it expireAgents can call this
members.sendPageEmail a current member of your shop a one-time sign-in link that opens one page: board (the day board, for owner or office), override (mark a job or visit done anyway, owner only), or capture (job photos, for anyone on the job; a field worker must be assigned to a visit on it)Agents can call this
media.requestCustomerUploadMake an expiring link the customer opens with no account and uses to send photos or videos for one jobAgents can call this
media.videoPartUrlsPresigned URLs for the parts of a video upload that media.requestUpload started in multipart modeAgents can call this
media.completeVideoUploadFinish a part upload after every part has been sentAgents can call this
media.abortVideoUploadStop a part upload and drop the parts already sentAgents can call this
media.mapPhotos with a GPS location as a GeoJSON FeatureCollection (points in longitude, latitude order), ready for a mapAgents can call this
media.setSummaryWrite or correct what a photo or video showsAgents can call this
media.needsSummaryPhotos and videos with no summary yet: older uploads, browser captures, and uploads whose agent could not look at the fileAgents can call this
quotes.withdrawWithdraw a draft or sent quote the customer has not signed, with an optional reasonAgents can call this
quotes.getOne customer quote in this shop: doc_no and doc_label (Q-12), status, every version with its lines, totals, and notes (the written scope of work, when the version has one), the job and customer, when it was sent and viewed, and the signer name and signed time once someone has signedAgents can call this
quotes.listCustomer quotes in one shop, newest firstAgents can call this
payments.connectLinkOwner only: the link to the shop's payment setup pageAgents can call this
fees.scheduleDoing Work's fee: the first $1,000 of payments each calendar month is free, then 0.5%, never more than $149 per owner per monthAgents can call this
fees.previewWhat Doing Work would keep on a payment of this size right now, the effective rate on it, and the owner's payment total so far this month (owner or office)Agents can call this
audit.listRead a shop's audit log, newest first (owner only)Agents can call this
customers.getOne customer with contacts, properties, custom fields and open balanceAgents can call this
customers.listCustomers of a shop, newest first, filtered by tag, lead source or archivedAgents can call this
customers.searchFind customers by name, company, email, phone or property addressAgents can call this
customers.updateChange a customer's name, kind, company, email, phone, billing address, lead source, tags or notesAgents can call this
customers.archiveArchive a customer (hidden from lists, history kept) or bring one backAgents can call this
customers.duplicatesLikely duplicate customers in a shop: same email, same phone digits, or same nameAgents can call this
customers.mergeMerge a duplicate customer into another: jobs, requests, contacts, properties and fields move overAgents can call this
customers.contactAddAdd a contact person to a customer (tenant, manager, billing, spouse)Agents can call this
customers.contactUpdateChange or remove one contact of a customerAgents can call this
jobs.setTagsSet the tags and lead source on a jobAgents can call this
customers.timelineEverything that happened with a customer, newest first: requests, jobs, quotes, signatures, invoices and paymentsAgents can call this
customers.statementA customer's account statement: every invoice with total, paid, refunded and balance, and the total owedAgents can call this
customers.privacyExportEverything the shop holds about one customer, as one JSON document, for a privacy requestAgents can call this
customers.privacyDeleteErase a customer's personal details for a privacy requestA person's own sign-in only
dispatch.suggestRead only: for an urgent or emergency visit, the shop's field workers and owners ranked by who is free (no overlapping visit, not on time off, inside their hours) and then by the fewest visits that dayAgents can call this
routes.setLocationSave the map point for a job's address, so routes.day can give it to you with each stop (owner or office)Agents can call this
routes.setStartSave where a worker starts the day (their home or a yard), or with no person_id the shop's yard, used when a worker has noneAgents can call this
routes.dayOne day's stops for planning a route, per worker in visit time order: each worker's start point (their own, else the shop yard), and for each stop the address, map point (null until you save one with routes.setLocation; source says where it came from), time, length, arrival window, priority, and locked when the worker is already on the way, there, or doneAgents can call this
routes.applyWrite a planned route back: new times, and optionally new workers, for up to 100 visits at once (owner or office)Agents can call this
vendors.createAdd a supplier the shop buys parts fromAgents can call this
vendors.updateChange a supplier's name, contact details or note, or archive it (archived: true)Agents can call this
vendors.listList the shop's suppliers (archived ones only with include_archived)Agents can call this
po.createStart a purchase order (draft) for parts for a job from a supplierAgents can call this
po.updateChange a draft purchase order's supplier, note or lines (lines replace all lines)Agents can call this
po.getA purchase order with its lines, what was received (in job cost) and the supplier's billAgents can call this
po.listList purchase orders for the shop, or for one job or supplier, newest firstAgents can call this
po.markOrderedMark a draft purchase order as sent to the supplier (the agent or a person sends it)Agents can call this
po.receiveRecord parts that arrivedAgents can call this
po.undoReceiptTake back a received material from a purchase order (wrong part, returned)Agents can call this
po.cancelCancel a purchase order that has nothing received (undo receipts first)Agents can call this
po.recordBillRecord the supplier's bill for a purchase order, for paying the supplierAgents can call this
calendar.createFeedMake a calendar feed link (.ics) of one worker's visits that a calendar app subscribes to (read only)Agents can call this
calendar.listFeedsCalendar feeds in a shop, newest first, with whether each is active and how often it was fetchedAgents can call this
calendar.revokeFeedTurn a calendar feed off nowAgents can call this
visit.on_my_wayMark that the worker is on the way to a visit when they tell their agent, for example on my way, there by 2Agents can call this
visit.arrivedMark that the worker has arrived at a visit when they tell their agent, for example I am hereAgents can call this
shops.setInvoiceRemindersTurn the automatic unpaid-invoice reminder on or off for the whole shop (owner only)Agents can call this
shops.setContactSet the phone and email customers see when they open a canceled invoice or quote link (owner only)Agents can call this
shops.setFieldCostsLet field workers in the shop see job costs (labor cost, material cost, expenses others entered, price book cost), or hide them again (owner only)Agents can call this
shops.setHubLinkInEmailsTurn the customer hub link in quote and invoice emails on or off for the whole shop (owner only)Agents can call this
invoices.setReminderTurn the automatic unpaid reminder on or off for one invoice (owner or office)Agents can call this
quotes.respondCustomer declines a quote or asks for changes (hosted page)Hosted page only
quotes.activityWhat the customer has done with a quote: when each version was first opened and how often, and any decline or change request with its noteAgents can call this
shops.setQuoteFollowupSet how many days after a quote is sent the customer gets one friendly follow-up email if they have not answered (owner only)Agents can call this
invoices.createCreate an invoice without a quote (AI can draft lines; a person who can send invoices approves agent-drafted lines before the invoice is sent)Agents can call this
invoices.createBatchCreate many invoices at once (up to 100), each from a job and the lines the worker wroteAgents can call this
invoices.getOne invoice with doc_no and doc_label (I-12), its lines, what has been paid, the balance, the due date, and whether a bank payment is still clearingAgents can call this
invoices.listInvoices in one shop, newest firstAgents can call this
invoices.pdfThe invoice as a PDF (base64), with shop, customer, lines, paid so far and balanceAgents can call this
invoices.agingAccounts receivable aging (limit is accepted and ignored; totals include every open invoice): every open invoice's balance by how late it is (current, 1-30, 31-60, 61-90, over 90 days past due), with totals per customer (owner or office); an invoice with no due date is due when sentAgents can call this
payments.listCard and bank payments in one shop, newest firstAgents can call this
payments.getOne card or bank payment, with the amount sent back and each refundAgents can call this
shops.setTipsTurn tips on or off on this shop's invoice pay page (owner only)Agents can call this
shops.setAgentMoneyOwner only, not an agent: set what this shop's agents may do with moneyA person's own sign-in only
shops.setReviewRequestSet the review link (for example your Google review page, https only) and how many days after an invoice is paid the customer gets one email asking for a review (owner only)Agents can call this
shops.getBrandHow this shop's quotes and invoices look: accent color, license number, footer text, logo size, and whether "Sent with Doing Work" showsAgents can call this
shops.setBrandSet how this shop's quotes, invoices and emails to customers look, on the customer's page, in the PDF and in every email (owner only)Agents can call this
quotes.pdfA quote as a PDF (base64) in the shop's brand: logo, accent color, license number, lines, options, the written scope of work when the version has notes, and totalAgents can call this
customers.setAutopayTurn auto-pay on or off for a customer (owner or office)Agents can call this
shops.setTaxReportBasisChoose how the sales tax report counts a period (owner only)Agents can call this
quotes.addAttachmentShow an uploaded photo or file of the same job with a quote, with an optional captionAgents can call this
quotes.removeAttachmentTake a photo or file off a quoteAgents can call this
quotes.listAttachmentsPhotos and files shown with a quote, in orderAgents can call this
media.tagAdd or remove tags on a photo (for example: leak, panel, permit)Agents can call this
media.searchFind photos across the shop that carry all the given tagsAgents can call this
jobs.findByTagJobs in the shop that carry all the given tags (set with jobs.setTags), newest first, up to 200Agents can call this
media.saveMarkupSave markup over a photo as a new layer version: arrows, lines, boxes, circles, text and freehand strokes in 0..1 photo coordinates (0,0 is top left)Agents can call this
media.getMarkupA photo's markup: the latest version unless one is named, with an SVG overlay to lay over the original photoAgents can call this
webhooks.deliveriesList deliveries to one webhook endpoint, newest first, with event, status, attempts and last HTTP statusAgents can call this
webhooks.retrySend a failed or dead delivery again from attempt 0 (owner or office)Agents can call this
shops.exportOwner only: everything the shop holds as one ZIP: data/<table>.csv and data/<table>.json for every shop table, files/ with job photos (and the original HEIC or TIFF file next to its JPEG copy) and PDFs, and manifest.jsonAgents can call this
members.permissionsWhat each current worker in a shop may do beyond their role: see_prices, see_costs, take_money, delete and manage_scheduleAgents can call this
members.setPermissionsOwner only, not an agent: turn a worker's permissions on or offA person's own sign-in only
shops.sendPermissionsWhat each role may send to a customer: quotes, invoices and visit recapsAgents can call this
shops.setSendPermissionsOwner only, not an agent: turn sending quotes, invoices or visit recaps on or off for one role (office, lead or field)A person's own sign-in only
shops.signUpCreate a shop for an owner who has already accepted the current Terms and PrivacyAgents can call this
jobs.completeMark a job done (owner or office)Agents can call this
notifications.getPrefsHow you hear about notes that mention you in a shop: email (on unless you turned it off) and text (off by default; texts are not sent yet)Agents can call this
notifications.setPrefsTurn mention emails or texts, or the night-before kit list email, on or off for yourself in one shopAgents can call this
crews.saveSave a named crew of workers to book together (owner or office)Agents can call this
crews.listThe shop's crews and their current workersAgents can call this
crews.archiveArchive a crew (owner or office)Agents can call this
financing.saveSave a financing link the shop works with, shown on quotes at or above its minimum (owner or office)Agents can call this
financing.listThe shop's financing linksAgents can call this
financing.archiveArchive a financing link so it no longer shows on quotes (owner or office)Agents can call this
tasks.createMake a tracked task from a crew message or plain words: a title, and optionally the job, the worker it is for, the note it came from and when it is due (due_on is a day, 5 PM shop time; or due_at)Agents can call this
tasks.listTasks you can see, filtered by worker, job, status (open by default; done, cancelled or all) and due (overdue, today in shop time, or all)Agents can call this
tasks.updateChange a task's title, job, worker or due time (due_on or due_at; null clears it)Agents can call this
tasks.closeClose a task as done (default) or cancelled, with an optional noteAgents can call this
quotes.searchSearch a shop's past quotes by scope words (for example "water heater 50 gallon garage"); AI can draft lines from a match and a person who can send quotes approves agent-drafted lines before the quote is sentAgents can call this
jobs.briefEverything already on a job, for a read before a visit or a proposal: notes (full text, paged), recordings and private truck notes (marked internal), photos and videos, this job's quotes and invoices, texts, calls (owner or office) and emails, other jobs at the same property, equipment, daily logs, open tasks, and similar past quotesAgents can call this
corrections.recordSave a correction when the worker edits, rejects, or says you got something wrong in a draft you made (a quote line, a recap, a task, a reply)Agents can call this
corrections.recentThe shop's recent corrections to drafts you made, newest first: what was changed or rejected and whyAgents can call this
quotes.draftFromVisitDraft quote lines from a visit, in the worker's words and what you saw and heardAgents can call this
quotes.draftRead one AI line draft from quotes.draftFromVisit, not a customer quoteAgents can call this
quotes.decideDraftLineRecord the worker's call on one drafted line: approve it (with any change they made to the words, quantity, price or basis) or reject itAgents can call this
quotes.finishDraftMake the quote from a draft once the worker decided every lineAgents can call this
quotes.comparablesPast prices related to one new line, for you to price itAgents can call this
shops.setPricingRulesSave the owner's pricing rules for their assistant, in their own words (owner only)Agents can call this
shops.visitStepsThe shop's guided visit steps, in order: the eight defaults until the shop edits themAgents can call this
shops.setVisitStepsReplace the shop's guided visit steps: add, remove, rename or reorder by sending the full listAgents can call this
customers.winBackWin-back list: customers with no visit in months (default 18; imported visits count), leaving out anyone with an open job or a visit coming upAgents can call this
customers.winBackQueueSend the win-back note to customers from customers.winBack: adds one service due date each (title, due in the shop's lead days), so the service_due_reminders job emails them once by the usual rulesAgents can call this
invoices.createFromTmBill a signed time and materials quote: approved time not billed yet at the signed rate, and materials at what the shop paid plus the signed markupAgents can call this
customers.audiencePick a customer audience by filters (tags, last job dates, kind of work, open quotes, money owed, maintenance plans, city or postal code, has email or phone) and get the counts and a page of matching customersAgents can call this
stock.setLevelTrack stock for a price book material, or correct its count after a physical count: sets the count on hand and the low point (stock.low is sent when the count falls to or below it; null for none)Agents can call this
stock.adjustRecord stock received, used, returned, lost or adjusted for a tracked materialAgents can call this
stock.listTracked materials with the count on hand and low pointAgents can call this
stock.movesStock history for one tracked material, newest first: every count, receipt, use, return, loss and adjustment with who and whenAgents can call this
services.addDueRecord when a customer's next service is due (owner or office), for example a yearly furnace tune-upAgents can call this
services.listDueList service due dates for the shop, soonest firstAgents can call this
services.updateDueChange an open service due date's title, date or repeat (owner or office)Agents can call this
services.completeDueMark a service due date done (owner or office)Agents can call this
services.cancelDueCancel an open service due date (owner or office), for example when the customer no longer wants the serviceAgents can call this
shops.setServiceDueEmailsTurn "service is due" reminder emails on or off for the shop and set how many days before the due date they go (1 to 60, default 14)Agents can call this
payroll.getPeriodThe shop's pay period setting (weekly, biweekly, semimonthly or monthly) and the current period's datesAgents can call this
payroll.setPeriodOwner or office: set the pay periodAgents can call this
payroll.hoursPayroll-ready hours for one pay period (or a custom from and to): approved minutes per person by category and by day, paid minutes (everything but break), and what still waits for approval or is still runningAgents can call this
payroll.exportCsvApproved hours for one pay period as CSV for a payroll provider: one row per person per day with work, drive, shop, break and paid hours (2 decimals)Agents can call this
shops.transferStartStart handing the shop to a current worker (owner, on a hosted page)Hosted page only
shops.transferAcceptAccept a hand-off and become the shop's owner (the person asked, on a hosted page)Hosted page only
shops.transferCancelStop an open hand-off: the owner cancels it, or the person asked declines itAgents can call this
shops.transfersHand-offs of a shop, newest firstAgents can call this
shops.closeCheckWhether the shop can close now (owner only)Agents can call this
shops.closeClose the shop for good (owner, on a hosted page, typing the shop name)Hosted page only
shops.reopenReopen a closed shop (only the owner who closed it, on a hosted page, within 90 days of closing)Hosted page only
invoices.voidVoid an invoice nobody has paid yet (owner or office), with a reasonAgents can call this
network.infoWhat the customer quote network covers: the area, the trades and the rulesAgents can call this
network.listingSetTurn customer requests on or off for a shop, and pick the kinds of work and the states (and optional ZIP codes) it serves (owner or office)Agents can call this
network.setAgentOptInLet the shop's agents turn customer requests on or off and change what the shop takes (owner only, with your own sign-in)A person's own sign-in only
network.listingGetA shop's customer request settings (owner or office)Agents can call this
network.inboxCustomer requests sent to a shop, newest first, with trade, town, ZIP, photo ids, the customer's text inside an untrusted wrapper, and a new-account flag (owner or office)Agents can call this
network.photoOne photo from a customer request, as base64 JPEG, PNG or WebP with location data removedAgents can call this
network.replyAnswer a customer request with the shop's own quote: lines and prices your workers wrote, and the deposit you want when the customer booksAgents can call this
network.declinePass on a customer request (owner or office)Agents can call this
network.markArrivedRecord that the shop showed up for a booked customer job (owner or office)Agents can call this
network.cancelBookingCancel a booked customer job (owner or office)Agents can call this
homeowner.webhookCreateAdd a webhook so your own assistant hears about your requests: homeowner.reply_received, homeowner.booking_changed, homeowner.dispute_decided and homeowner.request_deliveredAgents can call this
homeowner.webhookListYour webhooksAgents can call this
homeowner.webhookDeleteRemove one of your webhooksAgents can call this
homeowner.createRequestStart a customer request for quotes for any home-service work at any US address (address is an object, not a string, with required line1, locality, postal_code and jurisdiction (line2 is optional; jurisdiction is an ISO 3166-2 code like US-ID, and a US shop also accepts ID, id, or Idaho), for example {"line1":"100 Test St","locality":"Boise","postal_code":"83702","jurisdiction":"US-ID"}): the trade in your own words, the service address and what you needAgents can call this
homeowner.addPhotoAdd one photo (base64 JPEG, PNG, WebP, HEIC or TIFF) to a request you have not sent yetAgents can call this
homeowner.previewShopsBefore sending, list the shops on Doing Work that would get your request, each with why it matchesAgents can call this
homeowner.updateRequestChange a request you have not sent yet: the trade, category, address, title or detailsAgents can call this
homeowner.sendRequestSend your request to shops on Doing Work that serve the address and do the tradeAgents can call this
homeowner.getRequestYour request and every reply so farAgents can call this
homeowner.listRequestsYour customer requests, newest firstAgents can call this
homeowner.withdrawRequestWithdraw a request you have not bookedAgents can call this
homeowner.pickReplyBook one shop's replyAgents can call this
homeowner.reportNoShowTell Doing Work the shop you booked did not show upAgents can call this
network.disputeStatementTell Doing Work your side of a disputed no-show on a customer booking (owner or office)Agents can call this
network.claimGuestQuoteFor a shop that quoted a job from an outreach link before it had an account: bring that job into your shop's request inboxAgents can call this
phone.consentsConsent history and stop status for one customer phone number in the shop: every grant, confirmation and revoke, oldest firstAgents can call this
phone.stopPut a customer's number on the shop's stop list, for example when they asked out loud not to be texted or calledAgents can call this
phone.connectTwilioConnect the shop's own Twilio accountAgents can call this
phone.twilioNumbersThe phone numbers in the shop's connected Twilio account, and whether each one already sends its calls or texts somewhere elseAgents can call this
phone.useNumberUse one number from the shop's Twilio account for the shop's texts and callsAgents can call this
phone.setRouteChange how calls to the shop number are answered: forward (ring a phone, then voicemail by email) voicemail_email (straight to voicemail) or voice_ai (the shop's own AI agent answers, after phone.setVoiceAi; only when AI answering is turned on), and whether the shop's agent answers new texts (agent_answers_texts) instead of the shop inboxAgents can call this
phone.statusWhether the shop has Twilio connected and which number it uses, how calls are answered, and the texting registration statusAgents can call this
phone.disconnectDisconnect the shop's Twilio accountAgents can call this
phone.callsRecent calls to the shop number, newest first: who called, whether it was answered, went to voicemail or was missed, and the voicemail linkAgents can call this
phone.threadsText threads with customers, newest firstAgents can call this
phone.threadThe messages on one text thread, oldest firstAgents can call this
phone.takeThreadTake a text thread yourself: it is assigned to you, and sends paused by a customer's stop-like message start again once a person has read itHosted page only
phone.resumeThreadOwner only: start texts again on a thread that was paused because the customer wrote something stop-likeAgents can call this
phone.sendTextText a customer from the shop number, about their jobAgents can call this
phone.registrationStatusCheck the shop's texting registration with Twilio and save it: unregistered, brand_pending, campaign_pending, tollfree_pending, approved or failed, with the next stepAgents can call this
phone.portStatusWhere a request to move (port) the shop's existing number into its Twilio account stands, with the next stepAgents can call this
phone.setVoiceAiSet up the shop's own voice AI agent to answer calls: provider (elevenlabs or grok) and the agent's SIP addressAgents can call this
phone.setEmergencyHow the shop's voice agent handles emergency callsAgents can call this
phone.emergencyHow the shop's voice agent handles emergency calls, with suggested trigger wordsAgents can call this
phone.voiceAiThe shop's voice AI setup: provider, SIP address, whether a webhook secret is set (never the secret), and the URLs to give the providerAgents can call this
phone.voiceJobTypesJob types the shop's voice agent may book into live availability (booking_mode live): name, minutes, buffer, deposit, a daily cap and which workers may take themAgents can call this
phone.saveVoiceJobTypeAdd or change a job type the voice agent may book: name (what callers ask for, like AC tune-up), minutes, buffer_minutes (default the shop buffer), max_per_day, person_ids (the workers who may take it; empty means any worker) and deposit_minorAgents can call this
phone.archiveVoiceJobTypeStop the voice agent booking a job typeAgents can call this
phone.setOutboundAiTurn the shop's outbound AI calls on or offAgents can call this
phone.callCustomerAsk for one AI call to the job's customer: appointment_reminder (needs a future visit_id), on_my_way (a visit today with an assigned worker) or job_status (an open job)Agents can call this
phone.outboundCallsRecent AI call attempts for the shop, newest first: purpose, status, why it was refused, each check's result, and transcript_missing when a call reached the AI but no transcript came back (read it with the shop's provider)Agents can call this
agent.dueFollow-ups the agent scheduled for itself that are due now (tasks.create with for_agent)Agents can call this
agent.checkupA read-only look across the shop: stale quotes, overdue or failed invoices, tomorrow's visits that are not ready, recap drafts, unanswered customer requests, the one setup step still missing, jobs under the margin floor, double-booked workers, and maintenance that is dueAgents can call this
agent.snoozeHide one checkup suggestion so it is not repeatedAgents can call this
agent.emitNudgeEmit a push-style nudge.triggered webhook event from the top item of agent.checkup (or a custom check-in message) so a connected orchestrator can text or notify the shopAgents can call this
sync.setRefRecord the id an outside system (like quickbooks) uses for an invoice, payment, refund or customer, so your sync can update it instead of making a duplicateAgents can call this
sync.findRefsList outside ids a shop has recorded for one systemAgents can call this
sync.changesInvoices, payments, refunds and customers that changed since a time or cursor, oldest change first, each with its current details and outside idsAgents can call this
payouts.listA shop's payouts to its bank, newest first, so an agent can match each bank depositAgents can call this
payouts.getOne payout broken down: each payment and refund in it, the processor fee and the Doing Work fee on each, and the netAgents can call this
books.exportOwner or office: one month (or from and to) of the shop's money as a ZIP for a bookkeeper or for QuickBooks Online by hand: a ledger CSV of every invoice, void, payment, refund, fee and payout, QuickBooks Online invoice import files, and QuickBooks Online bank upload files for a clearing accountAgents can call this
books.exportsOwner or office: the shop's past books exports, newest first: period, row counts and sha256 (to check a file you were sent)Agents can call this
quotes.linesFromTasksTurn the flat rate tasks a worker picked into quote lines for quotes.create: shared tasks, or tasks per good, better, best optionAgents can call this
shops.setPriceStaleDaysSet how many days old a price book price may be before it shows as stale (owner or office)Agents can call this
me.smsConsentCheck your current SMS consent status for Doing Work alerts and check-ins, and get the hosted /p/account/sms opt-in linkAgents can call this
me.setSmsConsentGrant or revoke Doing Work SMS alerts and check-in consent for the signed-in personHosted page only

Team (unlimited workers)

OperationWhat it doesWho
members.inviteInvite a person by email as office, lead or fieldAgents can call this
members.acceptAccept an invite as the signed-in personAgents can call this
members.listCurrent members of a shop with role and start dateAgents can call this
members.endEnd a membership: the owner removes a worker, or a worker leavesAgents can call this
members.changeRoleOwner changes a worker among office, lead and fieldAgents can call this
approvals.setRuleOwner only, not an agent: require owner approval before an agent can run an actionA person's own sign-in only
approvals.removeRuleOwner only, not an agent: stop requiring approval for a ruleA person's own sign-in only
approvals.listRulesThe shop's approval rules: which agent actions wait for the ownerAgents can call this
approvals.listApproval requests for a shop, newest first, optionally by status (pending, approved, denied, failed, expired)Agents can call this
approvals.getOne approval request with its status and, once approved and run, the action's resultAgents can call this
approvals.decideOwner only, not an agent: approve or deny a pending agent actionA person's own sign-in only

Customers

OperationWhat it doesWho
customers.createAdd a customer to a shop, with kind, company, email, phone, billing address, lead source, tags and notes in one callAgents can call this
properties.addAdd a service address to a customer, with optional label and access notesAgents can call this
properties.listService addresses saved on a customer (properties_add, or jobs_create when you pass customer_id); a job with no customer keeps its address on jobs_get and is not listed hereAgents can call this
properties.updateChange a property's label or access notes, or archive itAgents can call this
equipment.addRecord equipment at a property: kind, make, model, serial, install date and warrantyAgents can call this
equipment.listEquipment at a property, or warranties ending soon across a shopAgents can call this
equipment.updateChange or archive an equipment recordAgents can call this

Jobs (unlimited)

OperationWhat it doesWho
jobs.createStart a job at a home, found or created from the address: address is an object, not a string, with required line1, locality, postal_code and jurisdiction (line2 is optional; jurisdiction is an ISO 3166-2 code like US-ID, and a US shop also accepts ID, id, or Idaho), for example {"line1":"100 Test St","locality":"Boise","postal_code":"83702","jurisdiction":"US-ID"}Agents can call this
jobs.listJobs of a shop you belong to, newest firstAgents can call this
jobs.getOne job with its home address and, when it was converted from a request, that requestAgents can call this

Job photos

OperationWhat it doesWho
media.requestUploadGet a signed upload URL for a job photo or videoAgents can call this
media.requestCaptureHosted photo capture: a signed upload URL for a worker taking a photo in the browserHosted page only
media.listList the photos and videos you are allowed to see, with what the agent said each shows (summary), who provided each file (shop or customer), the channel it arrived on, taken time, GPS location, heading and camera detailsAgents can call this
media.getOne photo or video's details, including its full summary (findings, readable text, measurements, transcript and key moments), taken time, location, camera fields and the full metadata read from the fileAgents can call this
shares.createMake a link to a gallery of a job's photos that anyone with the link can open without signing inAgents can call this
shares.listPhoto share links on a job, newest first, with whether each is still active and how often it was openedAgents can call this
shares.revokeTurn a photo share link off nowAgents can call this

Quotes (unlimited)

OperationWhat it doesWho
quotes.createCreate a quote (AI can draft lines; a person who can send quotes approves agent-drafted lines before the quote is sent)Agents can call this
quotes.sendLock the quote and get a single-use signing link for the customer (the customer signs on the hosted page; an agent cannot sign or accept a quote)Agents can call this
quotes.signSign a quote after accepting electronic signing and typing a nameHosted page only
quotes.revisePass the COMPLETE new line list; any line you omit is removedAgents can call this
pricebook.saveItemAdd a price book item, or change one when item_id is given (owner or office)Agents can call this
pricebook.listList the shop's price book items, by nameAgents can call this
pricebook.archiveItemArchive a price book item, or bring it back with archived false (owner or office)Agents can call this
pricebook.taskCostWhat a flat rate task costs the shop: its parts at cost plus estimated labor minutes at the shop's default hourly cost, and the margin at the price and at the member price (owner or office, needs see_costs)Agents can call this
pricebook.importPricesImport dated prices into the price book from CSV text (owner or office, needs see_prices, and see_costs when the file has a cost)Agents can call this
pricebook.priceHistoryThe dated prices saved for one price book item, newest effective date first (owner or office, needs see_prices)Agents can call this
pricebook.stalePricesPrice book items whose current price was set more than the shop's stale window ago (owner or office, needs see_prices)Agents can call this

Invoices and payments (unlimited)

OperationWhat it doesWho
invoices.createFromQuoteCreate an invoice for a signed quote, for the total of the option and optional lines the customer pickedAgents can call this
invoices.sendSend an invoice (or the next part of it) and get a single-use pay linkAgents can call this
invoices.payStart paying an invoice (hosted page)Hosted page only
invoices.markPaidOutsideRecord that the customer paid an invoice outside Doing Work (check, cash, financing, insurance or other)Agents can call this
invoices.refundRefund part or all of a payment (owner or office, or their agent)Agents can call this
taxes.saveRateAdd or change a sales tax rate the shop charges in one jurisdiction (owner or office)Agents can call this
taxes.listRatesThe shop's tax ratesAgents can call this
taxes.archiveRateStop using a tax rate (owner or office)Agents can call this
taxes.salesReportSales tax report for a period (owner or office), shop local dates, from and to inclusiveAgents can call this

Stripe connection

OperationWhat it doesWho
payments.connectStartStart payment setup for a shop (owner, hosted page)Hosted page only
cards.setupLinkGet a secure page where the customer saves a card with the shop's payment processor (owner or office)Agents can call this
cards.resaveOpen the card saving page from a save-your-card-again email link (hosted page only)Hosted page only
cards.getThe card a customer has on file (brand, last 4, expiry) and whether auto-pay is on (owner or office)Agents can call this
cards.removeRemove a customer's saved card (owner or office)Agents can call this

Idaho compliance

OperationWhat it doesWho
subcontractors.getThe Idaho 45-525(3) subcontractor and supplier statement for a job: the latest signed one, any prepared draft, and whether final payment needs oneAgents can call this
subcontractors.preparePrepare the Idaho 45-525(3) statement for the shop to sign: a list of subcontractors, materialmen and rental equipment providers over $500, or none_attestation "yes" for "No subcontractors or suppliers over $500 on this job"Agents can call this
subcontractors.signThe shop owner or office signs the Idaho 45-525(3) statement on a hosted page: a list (entries JSON), the "No subcontractors or suppliers over $500 on this job" attestation (none_attestation "yes"), or with neither, the prepared draftHosted page only

Signed job records

OperationWhat it doesWho
jobs.requestConfirmationGet a single-use link the customer opens to confirm the work was done (or flag a problem)Agents can call this
jobs.confirmCustomer confirms the work or flags a problem (hosted page)Hosted page only
records.keysPublic keys that verify signed job recordsAgents can call this
jobs.recordThe latest signed record for a job and its level (logged, paid, verified)Agents can call this
documents.photoReportRender a photo report PDF for a job: a title and the worker's own notes, then the job's photos in time order with stage and tagsAgents can call this
documents.dailyLogRender the daily log for a job as a PDF: each day's entries in the workers' own words with who wrote them, and the photos they attachedAgents can call this
documents.listPDF documents core made for a job (photo reports, daily logs and submitted forms), newest first, with each file's sha256Agents can call this
documents.getOne stored job PDF (base64) with its sha256, byte for byte as it was madeAgents can call this

Plans and fees

OperationWhat it doesWho
fees.statementA month's Doing Work fees for a shop: payments, fees by kind, the effective rate, and each line (owner or office)Agents can call this

Developers and platforms

OperationWhat it doesWho
webhooks.createAdd a webhook endpoint for a shop (owner or office, or their agent)Agents can call this
webhooks.listList a shop's webhook endpoints and their recent delivery countsAgents can call this
webhooks.deleteRemove a webhook endpointAgents can call this
platforms.createCreate a developer platform account (private beta)Agents can call this
platforms.listList the platform accounts this person owns and the shops each one manages: a person OAuth grant is not bound to one shop and gets that list, empty when they own none, and a shop-bound token (a named agent key or a dws_ shop token) is refused and should call me.shopsAgents can call this
platforms.grantManageLet a platform manage this shopHosted page only
platforms.revokeManageStop a platform from managing this shopAgents can call this
events.catalogEvery event a webhook can receive, with its payload keys and typesAgents can call this

Scheduling and visits

OperationWhat it doesWho
visits.createRecurringBook a repeating visit (daily, weekly or monthly, every n) for a jobAgents can call this
visits.cancelSeriesCancel the visits of a repeating series that have not started yet, from a time onward (default now)Agents can call this
visits.startMark a visit started (from scheduled, on the way, or arrived)Agents can call this
visits.doneMark a visit done, with an optional noteAgents can call this
visits.createBook a visit to a job at a time, optionally with the workers going (assignee_ids, a saved crew_id, or both)Agents can call this
visits.updateMove a visit or change its title, notes or arrival windowAgents can call this
visits.assignSet who is going on a visit: person_ids, a saved crew_id, or bothAgents can call this
visits.cancelCancel a visit that is scheduled, on the way, or arrivedAgents can call this
visits.setPrioritySet a visit's priority: normal, urgent or emergencyAgents can call this
visits.getOne visit with its job and workersAgents can call this
schedule.listA shop's visits that overlap a time window, earliest firstAgents can call this
availability.setHoursSet a worker's weekly hours, replacing what was thereAgents can call this
availability.addTimeOffAdd time off for a worker (vacation, sick, appointment)Agents can call this
availability.removeTimeOffRemove a time-off entryAgents can call this
availability.getA worker's weekly hours, time off, and booked visits in a window (at most 62 days)Agents can call this
schedule.settingsThe shop's scheduling setup: time zone, booking hours (or the default when none are set), arrival window, travel buffer, reminder lead time, whether on the way notices go out, and whether arrival times are shownAgents can call this
schedule.setShopHoursSet the shop's booking hours, replacing what was there (owner or office)Agents can call this
schedule.setRulesChange the shop's scheduling rules (owner or office; the time zone is owner only)Agents can call this
schedule.findTimeFind open times for a visit of a given length; each slot has starts_at in UTC plus local shop time and tz (for example local 2026-11-10 8:00 AM, tz America/Boise)Agents can call this
visits.onTheWayMark that the worker is on the way to a visit, with an optional ETA (eta_at, or eta_minutes from now)Agents can call this
visits.arrivedMark that the worker arrived at a visitAgents can call this
visits.noticesCustomer notices planned or handled for a visit (appointment reminder, on the way, arrived), with status pending, queued (handed to text, email, or both), cancelled or skipped and whyAgents can call this
schedule.openSlotsTimes the shop marked open for its voice agent to book (upcoming only), and which are bookedAgents can call this
schedule.addOpenSlotsMark times open for the shop's voice agent to book callers into (owner or office)Agents can call this
schedule.removeOpenSlotTake back an open time that is not booked yet (owner or office)Agents can call this
schedule.bookingPageRead the shop's public booking URL settings and Google Actions Center NAP readiness (booking_url, google_booking_url, service_zips, trade, and any missing NAP fields)Agents can call this
schedule.setBookingPageConfigure the shop's hosted public booking page (/p/book/<slug>) for Google Business Profile and Google Actions CenterAgents can call this
maintenance.createPlanStart a maintenance plan for a job's customer (owner or office)Agents can call this
maintenance.getPlanOne maintenance plan: price per term, current term, renewal date, each term's invoice, and this term's covered visits with the next one dueAgents can call this
maintenance.listPlansA shop's maintenance plans, optionally for one customer or by status, soonest renewal firstAgents can call this
maintenance.setPriceReplace a plan's priced lines (owner or office), and optionally its tax rateAgents can call this
maintenance.confirmPriceApply an agent's proposed price on a maintenance planA person's own sign-in only
maintenance.setVisitsChange how many visits a plan covers each term, and what they are called (owner or office)Agents can call this
maintenance.cancelPlanCancel a maintenance plan (owner or office)Agents can call this
schedule.kitListThe kit list for one worker and one day (tomorrow by default, shop time): each visit they are on with the address, map link, the work from the quote, materials on the job, open checklist items, pinned notes and the latest photosAgents can call this
schedule.setKitListEmailSet the hour (0 to 23, shop time) the night-before kit list email goes to each worker with visits the next day, or turn it off with on falseAgents can call this
schedule.capacityHow booked the next working days are: for each day, open worker minutes inside shop hours (and each worker's own hours) minus time off, booked minutes, percent booked, and how many visits of visit_minutes (default 120) still fit, counted the way schedule.findTime offers timesAgents can call this
visits.briefOne page brief before a visit: the visit and customer, the address, the request it came from, recent texts with the customer (customer words come wrapped as untrusted text) and calls (owner or office only), emails, notes with their full text and channel, recordings and private truck notes (marked internal), photos and videos with who provided each file (shop or customer) and the channel it arrived on, this job's quotes and invoices, other jobs at the same property, equipment, daily logs, open tasks, and similar past quotesAgents can call this
visits.addRecordingAdd a walkthrough recording the worker sent you, during or after the visitAgents can call this
visits.recordingsRecordings on a visit, newest first: when each was recorded, what the worker said it was, the note its transcript became, and private worker_notesAgents can call this
visits.draftRecapDraft the recap email for the customer after a visitAgents can call this
visits.editRecapChange the subject or words of a recap draft before the worker approves itAgents can call this
visits.approveRecapSend the recap: it goes to the customer by email from the shop, with replies to the shop ownerAgents can call this
visits.stepsThe guided visit steps for a visit, each done, skipped, or open, and the next one to suggestAgents can call this
visits.markStepMark a guided visit step done or skipped (or open again) when the worker says soAgents can call this
schedule.routeOne day's visits as a route: stops in time order with the customer's name, phone and address, a map link per stop and one multi-stop driving directions link (first 10 stops)Agents can call this
schedule.eventsVisits between two dates as calendar events (uid, title, start, end, location, status confirmed, tentative or cancelled), ready to copy into an outside calendar; save the uid to update the same event laterAgents can call this
visits.changeRequestsCustomers' requests to move or cancel a visit, from the customer hub, newest firstAgents can call this
visits.answerChangeAnswer a customer's request to move or cancel a visitAgents can call this

Field work (checklists, forms, time, notes, change orders, subcontractors)

OperationWhat it doesWho
logs.addWrite a daily log entry on a job: what happened on site that day, in the worker's own wordsAgents can call this
logs.listDaily log entries on a job, oldest first, optionally between two dates (inclusive)Agents can call this
logs.removeTake a daily log entry out of the logAgents can call this
signatures.requestAsk someone to sign a document on a hosted page, and get the signing link to give themAgents can call this
signatures.newLinkA new signing link for an open signature requestAgents can call this
signatures.cancelCancel an open signature requestAgents can call this
signatures.getOne signature request: the document text (or stored PDF id) and its sha256, and the signature when signed (who, typed name, consent text and its sha256, surface, time)Agents can call this
signatures.listSignature requests for a job, a customer or a whole shop, newest first, with status and who signedAgents can call this
signatures.signSign a document after reading it, typing your name and agreeing to sign electronicallyHosted page only
checklists.saveTemplateCreate a checklist template, or replace one (give checklist_template_id)Agents can call this
checklists.listTemplatesThe shop's checklist templates with their itemsAgents can call this
checklists.archiveTemplateArchive a checklist template so it is no longer offeredAgents can call this
checklists.createPut a checklist on a job, or on one visit of the job (visit_id)Agents can call this
checklists.listChecklists on a job (all of them, job-level and per visit) or on one visit, with counts of open required items and sign-off stateAgents can call this
checklists.getOne checklist with every item (removed items included and marked), who ticked what and when, and its sign-offAgents can call this
checklists.checkItemTick (done true) or untick an item, with an optional noteAgents can call this
checklists.addItemsAdd items to the end of a checklist (owner or office)Agents can call this
checklists.removeItemRemove an item from a checklist (it stays in the history, marked removed)Agents can call this
checklists.requestSignOffAsk for a sign-off on a finished checklist and get the signing linkAgents can call this
forms.saveTemplateCreate a form template (an inspection, a safety sheet, a start-up report), or replace one (give form_template_id)Agents can call this
forms.listTemplatesThe shop's form templates with their fieldsAgents can call this
forms.archiveTemplateArchive a form template so it is no longer offeredAgents can call this
forms.startStart a form on a job, or on one visit of the job (visit_id)Agents can call this
forms.fillSave answers on a draft formAgents can call this
forms.submitSubmit a draft form: every required field must be answered (forms.get lists what is missing)Agents can call this
forms.cancelCancel a draft form (kept in history)Agents can call this
forms.getOne form with its fields, answers, the required fields still missing, its stored PDF id and hash once submitted, and its sign-offAgents can call this
forms.listForms on a job (job-level and per visit), or on one visit, newest first, without fields and answersAgents can call this
forms.requestSignOffAsk for a signature on a submitted form and get the signing link (owner or office)Agents can call this
notes.addWrite a note on any shop record: a job, visit, photo or video, customer, property, equipment, quote, invoice, request, worker, payment, price book item, maintenance plan or the shop (target_kind and target_id; job_id or visit_id alone also work)Agents can call this
notes.addVoiceMemoSave a voice memo as a note: send the transcript your agent made, the memo's length in seconds, when it was recorded, and what transcribed itAgents can call this
notes.updateChange a noteAgents can call this
notes.removeTake a note off its recordAgents can call this
notes.getOne note you may see, with every earlier wording (history, oldest first)Agents can call this
notes.listNotes you may see on one record (target_kind and target_id), on a job (job_id: the job, its visits and anything on it such as its photos, quotes and invoices), on one visit, or the notes that mention you (mentioning_me)Agents can call this
notes.searchFind notes you may see by their words, across every record in a shopAgents can call this
changes.createWrite a change order on a job: a priced change to its scope (AI can draft lines; the owner approves them before the change order is sent)Agents can call this
changes.listA job's change orders and its money picture: signed quotes (contract_minor) + approved change orders = revised_total_minor; pending (sent, not yet signed); invoiced on live invoices; unbilled; and approved change orders not on an invoice yetAgents can call this
changes.getOne change order with its lines, totals, status, signature and invoiceAgents can call this
changes.sendOwner or office: ask the customer to approve a change orderAgents can call this
changes.cancelCancel a draft or sent change order (its open signature request is cancelled too, so the link stops working)Agents can call this
changes.invoiceBill approved change orders on a normal invoice (draft; send it with invoices.send)Agents can call this
timesheets.clockInStart a person's clock: on a job (work), or drive, shop or break timeAgents can call this
timesheets.clockOutStop a person's running clockAgents can call this
timesheets.currentA person's running clock in a shop, or null when they are not clocked inAgents can call this
timesheets.addAdd time after the fact (a manual entry with a start and an end, at most 24 hours)Agents can call this
timesheets.updateFix a time entry that is not approved: its start, end, category, job, visit or notesAgents can call this
timesheets.voidTake back a time entry that was never approved (kept in history, no longer counted)Agents can call this
timesheets.decideOwner or office: approve or reject stopped time entries (up to 200 at once, one shop)Agents can call this
timesheets.reopenOwner only: reopen approved time so it can be fixed (it goes back to waiting for approval)Agents can call this
timesheets.listTime entries in a shop between dates (the shop's time zone), or on one job, with minutes by category and by person, and approved minutesAgents can call this
timesheets.setRateOwner or office: set what an hour of a worker's time costs the shop (wage plus burden), or the shop default when person_id is left outAgents can call this
timesheets.listRatesLabor cost rates in force now: the shop default and each worker's own, plus upcoming onesAgents can call this
materials.addRecord a material used on a job (optionally on one of its visits): from the price book (pricebook_item_id; its name, unit, price, cost and taxable are copied as they are now) or typed in (name, unit, and optionally the price and cost per unit)Agents can call this
materials.updateChange a recorded material's quantity, visit or notesAgents can call this
materials.removeRemove a recorded material (recorded in error or returned)Agents can call this
materials.listMaterials recorded on a job (or one visit), with the price and cost totals of those still countedAgents can call this
subs.addAdd a subcontractor to a job: a company and the one email they will sign in withAgents can call this
subs.listSubcontractors on a job, or on every job in the shop: status invited, joined, expired or removed, when they last opened their pageAgents can call this
subs.updateChange a subcontractor's contact name, trade or scope note (what they see on their page)Agents can call this
subs.removeTake a subcontractor off a job, for good: their link stops working at onceAgents can call this
subs.notesNotes subcontractors left on a job, newest firstAgents can call this
subs.viewThe subcontractor's page for one job: the shop, job summary, work address, scope note, upcoming visit times and their notesHosted page only
subs.addNoteLeave a note for the shop on this job, as the subcontractor (up to 20 a day)Hosted page only

Customer hub, requests and customer emails

OperationWhat it doesWho
requests.createLog a request for work from a customer or a new leadAgents can call this
requests.listRequests of a shop, newest first, filtered by stage, customer or tagAgents can call this
requests.pipelineHow many open requests a shop has in each stage, and how many were won, invoiced or lost in the last 30 daysAgents can call this
requests.getOne request with its customer and the job it becameAgents can call this
requests.updateMove a request to another stage or change its details, customer or propertyAgents can call this
requests.convertTurn a request into a job at its property or address and link them both waysAgents can call this
requests.formCreateTurn on the shop's public request form and get its keyAgents can call this
requests.submitFormSend a shop a request through its public formAgents can call this
templates.saveSave a quote template: worker-written lines (and good, better, best options) to start quotes fromAgents can call this
templates.listList the shop's saved quote templates with their linesAgents can call this
templates.archiveArchive a quote template, or bring it back with archived false (owner or office)Agents can call this
requests.leadSettingsThe shop's lead rules: reply to new requests within a minute (on or off), after hours (offer the first open time, or hold for the morning), and which lead types to flag or skipAgents can call this
requests.setLeadSettingsChange the shop's lead rulesAgents can call this
messages.templatesThe shop's customer message templates, one per kind (invoice_reminder, quote_followup, review_request): the wording in use (custom or built-in), the placeholders each kind takes, and the locked link placeholder that must stay in the bodyAgents can call this
messages.saveTemplateSet the subject and body wording for one kind of automatic customer emailAgents can call this
messages.resetTemplateGo back to the built-in wording for one kind of automatic customer emailAgents can call this
messages.previewTemplateShow how one kind of automatic customer email reads, filled with sample customer details and the shop's nameAgents can call this
hub.createLinkMake a customer hub link: one page where this customer sees their quotes, jobs, invoices, upcoming visits and requests with you, pays, asks to move or cancel a visit, and asks for new workAgents can call this
hub.linksA customer's hub links, newest first: when each was made, when it expires or was revoked, and how often and when it was last openedAgents can call this
hub.revokeLinkStop a customer hub link working, for goodAgents can call this
hub.viewThe customer hub for the signed-in customer: their quotes, jobs, invoices with what is still owed, upcoming visits with any change request, requests with this shop, and their active maintenance plans (what each covers, the next visit due, price per term, renewal date and card on file)Hosted page only
hub.openOpen a sent quote or an unpaid invoice from the customer hub: returns a fresh page link for that one item, for the signed-in customer only, good for a dayHosted page only
hub.requestVisitChangeFrom the customer hub, ask the shop to move (reschedule, with the times that work better) or cancel an upcoming visitHosted page only
hub.withdrawVisitChangeFrom the customer hub, take back your own open request to move or cancel a visitHosted page only
hub.requestWorkFrom the customer hub, ask the shop for new workHosted page only

Costs, expenses and reports

OperationWhat it doesWho
tips.reportTips customers paid, by invoice and in total, between two dates (owner or office)Agents can call this
expenses.addRecord money a worker spent on a job, with the receipt photoAgents can call this
expenses.updateChange an expense: date, vendor, category, amount, tax, receipt photo or noteAgents can call this
expenses.removeTake an expense off the books (kept in history)Agents can call this
expenses.listExpenses on a job, or across the shop between dates, with totals by categoryAgents can call this
reports.revenueMoney collected between two dates (inclusive, UTC), by month: card and bank payments through Doing Work less refunds, and payments recorded as taken outside Doing Work, shown apartAgents can call this
reports.owedMoney customers still owe on sent invoices, grouped by how long ago each invoice went out: 0 to 30, 31 to 60, 61 to 90 and over 90 daysAgents can call this
reports.quoteWinRateOf the quotes made between two dates (inclusive, UTC) and sent, how many were signed, declined, or are still waitingAgents can call this
costs.jobJob costing for one job: contract, invoiced, collected and revenue against labor (approved and pending time at each entry's cost rate), materials at cost, expenses and Doing Work fees, with profit and marginAgents can call this
costs.jobsJob costing across jobs dated between two days (inclusive, in the shop's time zone), with totalsAgents can call this
costs.marginAlertThe shop's profit alert: the margin floor in percent, or null when offAgents can call this
costs.setMarginAlertSet a profit alert (owner only): when an invoiced job's margin drops under below_percent, the job.margin_low event fires once for it (subscribe with a webhook)Agents can call this
reports.todayThe shop's today queues in one call: visits today, visits in the next 7 days with nobody assigned, new requests, quotes and change orders waiting on the customer, overdue and draft invoices, done jobs not invoiced, time waiting for approval, approvals waiting on the owner, open tasks due by today and done visits with no quote sent yetAgents can call this
reports.weekHow the shop did in one week (Monday to Sunday in the shop's time zone) against the week before: money collected, refunded, paid outside and invoiced; quotes sent and signed; jobs, visits, customers and requests; time logged and expensesAgents can call this
reports.morningEmailWhether the owner's morning email is onAgents can call this
reports.setMorningEmailTurn the owner's morning email on or off (owner only)Agents can call this
reports.saveSave a report to run again later: a name, one report operation (reports.revenue, reports.owed, reports.quoteWinRate, reports.today, reports.week, costs.jobs), its settings, and an optional moving date range (today, this_week, last_week, this_month, last_month, last_7_days, last_30_days, last_90_days, this_quarter, last_quarter, this_year, last_year) worked out on the shop's calendar each runAgents can call this
reports.listSavedThe shop's saved reports, by nameAgents can call this
reports.removeSavedRemove a saved report (kept for the record; its name is free to use again)Agents can call this
reports.runRun a saved report now: its date range is worked out on the shop's calendar (or around as_of), and the report operation runs with the caller's own permissionsAgents can call this
OperationWhat it doesWho
fields.defineAdd a custom field to customers, properties, jobs, quotes or invoices for a shopAgents can call this
fields.listCustom fields a shop has defined, optionally for one kind of recordAgents can call this
fields.setSet one custom field value on a customer, property, job, quote or invoiceAgents can call this
fields.getCustom field values on one record, with any required fields still emptyAgents can call this
tags.listEvery tag used in the shop, with how many photos and jobs carry itAgents can call this
search.globalSearch one shop for customers (name, email, phone), properties (address), equipment (kind, make, model, serial, notes), jobs (summary), requests (title), notes (words, on any record) and photos and videos (what the agent said they show, readable text such as serial numbers, video transcripts)Agents can call this
imports.fieldsThe customer import fields and the built-in presets (jobber, housecall_pro, servicetitan, companycam) with the export column each readsAgents can call this
imports.previewDry run of a customer CSV importAgents can call this
imports.runOwner only: import customers (and one service address each) from a CSV with the mapping the owner confirmedAgents can call this
imports.historyFieldsFields for importing history from another system (jobs with visit history, open quotes, unpaid invoices, price book, equipment, maintenance plans as service-due reminders, payment history as read-only records) and the jobber and housecall_pro presets per kindAgents can call this
imports.historyPreviewDry run of a history import (kind jobs, quotes, invoices, pricebook, equipment, maintenance_plans, payments or flat_rate)Agents can call this
imports.historyRunOwner only: write a history import the owner confirmed in imports.historyPreview (send its preview_hash, plus the same csv, kind, source, on_match, include_won and mapping)Agents can call this
imports.paymentHistoryOwner or office: payments imported from another system (read-only history; never charged, never counted toward Doing Work fees)Agents can call this
bulk.runRun one safe action on up to 200 records: customers.addTags, customers.removeTags, customers.archive, customers.unarchive, jobs.addTags, jobs.removeTags, visits.assignAgents can call this