--- title: Doing Work API reference description: What each operation in this reference does, when to use it, inputs, examples, errors, and what to tell the owner. Free field service software for trade. url: https://doingwork.work/docs/reference/ --- # 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 | Operation | What it does | Who | |---|---|---| | [auth.requestLink](https://doingwork.work/docs/reference/auth-requestlink/) | Email a one-time sign-in link | Agents can call this | | [auth.redeemLink](https://doingwork.work/docs/reference/auth-redeemlink/) | Exchange a sign-in link token for a browser session | Hosted page only | | [auth.oauthRegister](https://doingwork.work/docs/reference/auth-oauthregister/) | Register an OAuth client (RFC 7591 dynamic registration) | Agents can call this | | [auth.oauthAuthorize](https://doingwork.work/docs/reference/auth-oauthauthorize/) | A signed-in person approves an agent client | Agents can call this | | [auth.oauthToken](https://doingwork.work/docs/reference/auth-oauthtoken/) | Exchange an authorization code and PKCE verifier, or a refresh token, for a short-lived agent access token and a new refresh token | Agents can call this | | [me.get](https://doingwork.work/docs/reference/me-get/) | The signed-in person | Agents can call this | | [keys.create](https://doingwork.work/docs/reference/keys-create/) | Make a named agent key for one shop (owner only) | A person's own sign-in only | | [keys.list](https://doingwork.work/docs/reference/keys-list/) | List 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 revoked | Agents can call this | | [keys.revoke](https://doingwork.work/docs/reference/keys-revoke/) | Revoke a named agent key (owner only) | Agents can call this | | [keys.connections](https://doingwork.work/docs/reference/keys-connections/) | List 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 revoked | Agents can call this | | [keys.revokeConnection](https://doingwork.work/docs/reference/keys-revokeconnection/) | Revoke an outside agent a worker connected through OAuth (owner only) | Agents can call this | | [agents.register](https://doingwork.work/docs/reference/agents-register/) | Preferred when you know the owner's email: type service_auth and login_hint | Agents can call this | | [agents.claim](https://doingwork.work/docs/reference/agents-claim/) | auth.md claim | Agents can call this | | [agents.approve](https://doingwork.work/docs/reference/agents-approve/) | Hosted 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 terms | Hosted page only | | [agents.deny](https://doingwork.work/docs/reference/agents-deny/) | Hosted claim page only: the person turns the agent down | Hosted page only | | [legal.documents](https://doingwork.work/docs/reference/legal-documents/) | The legal documents Doing Work asks people to accept, with the current version and a link to the text | Agents can call this | | [legal.status](https://doingwork.work/docs/reference/legal-status/) | What 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 accepting | Agents can call this | | [legal.accept](https://doingwork.work/docs/reference/legal-accept/) | Record that the signed-in person accepts the current version of a legal document (clickwrap) | A person's own sign-in only | | [legal.shopTerms](https://doingwork.work/docs/reference/legal-shopterms/) | For 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 status | Agents can call this | | [legal.acceptShopTerms](https://doingwork.work/docs/reference/legal-acceptshopterms/) | The 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.arbitrationOptOut](https://doingwork.work/docs/reference/legal-arbitrationoptout/) | The shop owner, on the hosted shop terms page, opts the shop out of section 19 arbitration and the class action waiver | Hosted page only | ## Shop | Operation | What it does | Who | |---|---|---| | [auth.sendLink](https://doingwork.work/docs/reference/auth-sendlink/) | Email 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.start](https://doingwork.work/docs/reference/me-start/) | Start here | Agents can call this | | [me.shops](https://doingwork.work/docs/reference/me-shops/) | Shops the signed-in person belongs to right now, with their role | Agents can call this | | [shops.create](https://doingwork.work/docs/reference/shops-create/) | Create a shop | Agents can call this | | [members.resendInvite](https://doingwork.work/docs/reference/members-resendinvite/) | Email an open invite again with a new link, for a worker or office member who lost it or let it expire | Agents can call this | | [members.sendPage](https://doingwork.work/docs/reference/members-sendpage/) | Email 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.requestCustomerUpload](https://doingwork.work/docs/reference/media-requestcustomerupload/) | Make an expiring link the customer opens with no account and uses to send photos or videos for one job | Agents can call this | | [media.videoPartUrls](https://doingwork.work/docs/reference/media-videoparturls/) | Presigned URLs for the parts of a video upload that media.requestUpload started in multipart mode | Agents can call this | | [media.completeVideoUpload](https://doingwork.work/docs/reference/media-completevideoupload/) | Finish a part upload after every part has been sent | Agents can call this | | [media.abortVideoUpload](https://doingwork.work/docs/reference/media-abortvideoupload/) | Stop a part upload and drop the parts already sent | Agents can call this | | [media.map](https://doingwork.work/docs/reference/media-map/) | Photos with a GPS location as a GeoJSON FeatureCollection (points in longitude, latitude order), ready for a map | Agents can call this | | [media.setSummary](https://doingwork.work/docs/reference/media-setsummary/) | Write or correct what a photo or video shows | Agents can call this | | [media.needsSummary](https://doingwork.work/docs/reference/media-needssummary/) | Photos and videos with no summary yet: older uploads, browser captures, and uploads whose agent could not look at the file | Agents can call this | | [quotes.withdraw](https://doingwork.work/docs/reference/quotes-withdraw/) | Withdraw a draft or sent quote the customer has not signed, with an optional reason | Agents can call this | | [quotes.get](https://doingwork.work/docs/reference/quotes-get/) | One 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 signed | Agents can call this | | [quotes.list](https://doingwork.work/docs/reference/quotes-list/) | Customer quotes in one shop, newest first | Agents can call this | | [payments.connectLink](https://doingwork.work/docs/reference/payments-connectlink/) | Owner only: the link to the shop's payment setup page | Agents can call this | | [fees.schedule](https://doingwork.work/docs/reference/fees-schedule/) | Doing Work's fee: the first $1,000 of payments each calendar month is free, then 0.5%, never more than $149 per owner per month | Agents can call this | | [fees.preview](https://doingwork.work/docs/reference/fees-preview/) | What 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.list](https://doingwork.work/docs/reference/audit-list/) | Read a shop's audit log, newest first (owner only) | Agents can call this | | [customers.get](https://doingwork.work/docs/reference/customers-get/) | One customer with contacts, properties, custom fields and open balance | Agents can call this | | [customers.list](https://doingwork.work/docs/reference/customers-list/) | Customers of a shop, newest first, filtered by tag, lead source or archived | Agents can call this | | [customers.search](https://doingwork.work/docs/reference/customers-search/) | Find customers by name, company, email, phone or property address | Agents can call this | | [customers.update](https://doingwork.work/docs/reference/customers-update/) | Change a customer's name, kind, company, email, phone, billing address, lead source, tags or notes | Agents can call this | | [customers.archive](https://doingwork.work/docs/reference/customers-archive/) | Archive a customer (hidden from lists, history kept) or bring one back | Agents can call this | | [customers.duplicates](https://doingwork.work/docs/reference/customers-duplicates/) | Likely duplicate customers in a shop: same email, same phone digits, or same name | Agents can call this | | [customers.merge](https://doingwork.work/docs/reference/customers-merge/) | Merge a duplicate customer into another: jobs, requests, contacts, properties and fields move over | Agents can call this | | [customers.contactAdd](https://doingwork.work/docs/reference/customers-contactadd/) | Add a contact person to a customer (tenant, manager, billing, spouse) | Agents can call this | | [customers.contactUpdate](https://doingwork.work/docs/reference/customers-contactupdate/) | Change or remove one contact of a customer | Agents can call this | | [jobs.setTags](https://doingwork.work/docs/reference/jobs-settags/) | Set the tags and lead source on a job | Agents can call this | | [customers.timeline](https://doingwork.work/docs/reference/customers-timeline/) | Everything that happened with a customer, newest first: requests, jobs, quotes, signatures, invoices and payments | Agents can call this | | [customers.statement](https://doingwork.work/docs/reference/customers-statement/) | A customer's account statement: every invoice with total, paid, refunded and balance, and the total owed | Agents can call this | | [customers.privacyExport](https://doingwork.work/docs/reference/customers-privacyexport/) | Everything the shop holds about one customer, as one JSON document, for a privacy request | Agents can call this | | [customers.privacyDelete](https://doingwork.work/docs/reference/customers-privacydelete/) | Erase a customer's personal details for a privacy request | A person's own sign-in only | | [dispatch.suggest](https://doingwork.work/docs/reference/dispatch-suggest/) | Read 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 day | Agents can call this | | [routes.setLocation](https://doingwork.work/docs/reference/routes-setlocation/) | Save 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.setStart](https://doingwork.work/docs/reference/routes-setstart/) | Save 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 none | Agents can call this | | [routes.day](https://doingwork.work/docs/reference/routes-day/) | One 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 done | Agents can call this | | [routes.apply](https://doingwork.work/docs/reference/routes-apply/) | Write 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.create](https://doingwork.work/docs/reference/vendors-create/) | Add a supplier the shop buys parts from | Agents can call this | | [vendors.update](https://doingwork.work/docs/reference/vendors-update/) | Change a supplier's name, contact details or note, or archive it (archived: true) | Agents can call this | | [vendors.list](https://doingwork.work/docs/reference/vendors-list/) | List the shop's suppliers (archived ones only with include_archived) | Agents can call this | | [po.create](https://doingwork.work/docs/reference/po-create/) | Start a purchase order (draft) for parts for a job from a supplier | Agents can call this | | [po.update](https://doingwork.work/docs/reference/po-update/) | Change a draft purchase order's supplier, note or lines (lines replace all lines) | Agents can call this | | [po.get](https://doingwork.work/docs/reference/po-get/) | A purchase order with its lines, what was received (in job cost) and the supplier's bill | Agents can call this | | [po.list](https://doingwork.work/docs/reference/po-list/) | List purchase orders for the shop, or for one job or supplier, newest first | Agents can call this | | [po.markOrdered](https://doingwork.work/docs/reference/po-markordered/) | Mark a draft purchase order as sent to the supplier (the agent or a person sends it) | Agents can call this | | [po.receive](https://doingwork.work/docs/reference/po-receive/) | Record parts that arrived | Agents can call this | | [po.undoReceipt](https://doingwork.work/docs/reference/po-undoreceipt/) | Take back a received material from a purchase order (wrong part, returned) | Agents can call this | | [po.cancel](https://doingwork.work/docs/reference/po-cancel/) | Cancel a purchase order that has nothing received (undo receipts first) | Agents can call this | | [po.recordBill](https://doingwork.work/docs/reference/po-recordbill/) | Record the supplier's bill for a purchase order, for paying the supplier | Agents can call this | | [calendar.createFeed](https://doingwork.work/docs/reference/calendar-createfeed/) | Make a calendar feed link (.ics) of one worker's visits that a calendar app subscribes to (read only) | Agents can call this | | [calendar.listFeeds](https://doingwork.work/docs/reference/calendar-listfeeds/) | Calendar feeds in a shop, newest first, with whether each is active and how often it was fetched | Agents can call this | | [calendar.revokeFeed](https://doingwork.work/docs/reference/calendar-revokefeed/) | Turn a calendar feed off now | Agents can call this | | [visit.on_my_way](https://doingwork.work/docs/reference/visit-on_my_way/) | Mark that the worker is on the way to a visit when they tell their agent, for example on my way, there by 2 | Agents can call this | | [visit.arrived](https://doingwork.work/docs/reference/visit-arrived/) | Mark that the worker has arrived at a visit when they tell their agent, for example I am here | Agents can call this | | [shops.setInvoiceReminders](https://doingwork.work/docs/reference/shops-setinvoicereminders/) | Turn the automatic unpaid-invoice reminder on or off for the whole shop (owner only) | Agents can call this | | [shops.setContact](https://doingwork.work/docs/reference/shops-setcontact/) | Set the phone and email customers see when they open a canceled invoice or quote link (owner only) | Agents can call this | | [shops.setFieldCosts](https://doingwork.work/docs/reference/shops-setfieldcosts/) | Let 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.setHubLinkInEmails](https://doingwork.work/docs/reference/shops-sethublinkinemails/) | Turn the customer hub link in quote and invoice emails on or off for the whole shop (owner only) | Agents can call this | | [invoices.setReminder](https://doingwork.work/docs/reference/invoices-setreminder/) | Turn the automatic unpaid reminder on or off for one invoice (owner or office) | Agents can call this | | [quotes.respond](https://doingwork.work/docs/reference/quotes-respond/) | Customer declines a quote or asks for changes (hosted page) | Hosted page only | | [quotes.activity](https://doingwork.work/docs/reference/quotes-activity/) | What the customer has done with a quote: when each version was first opened and how often, and any decline or change request with its note | Agents can call this | | [shops.setQuoteFollowup](https://doingwork.work/docs/reference/shops-setquotefollowup/) | Set 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.create](https://doingwork.work/docs/reference/invoices-create/) | Create 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.createBatch](https://doingwork.work/docs/reference/invoices-createbatch/) | Create many invoices at once (up to 100), each from a job and the lines the worker wrote | Agents can call this | | [invoices.get](https://doingwork.work/docs/reference/invoices-get/) | One 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 clearing | Agents can call this | | [invoices.list](https://doingwork.work/docs/reference/invoices-list/) | Invoices in one shop, newest first | Agents can call this | | [invoices.pdf](https://doingwork.work/docs/reference/invoices-pdf/) | The invoice as a PDF (base64), with shop, customer, lines, paid so far and balance | Agents can call this | | [invoices.aging](https://doingwork.work/docs/reference/invoices-aging/) | Accounts 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 sent | Agents can call this | | [payments.list](https://doingwork.work/docs/reference/payments-list/) | Card and bank payments in one shop, newest first | Agents can call this | | [payments.get](https://doingwork.work/docs/reference/payments-get/) | One card or bank payment, with the amount sent back and each refund | Agents can call this | | [shops.setTips](https://doingwork.work/docs/reference/shops-settips/) | Turn tips on or off on this shop's invoice pay page (owner only) | Agents can call this | | [shops.setAgentMoney](https://doingwork.work/docs/reference/shops-setagentmoney/) | Owner only, not an agent: set what this shop's agents may do with money | A person's own sign-in only | | [shops.setReviewRequest](https://doingwork.work/docs/reference/shops-setreviewrequest/) | Set 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.getBrand](https://doingwork.work/docs/reference/shops-getbrand/) | How this shop's quotes and invoices look: accent color, license number, footer text, logo size, and whether "Sent with Doing Work" shows | Agents can call this | | [shops.setBrand](https://doingwork.work/docs/reference/shops-setbrand/) | Set 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.pdf](https://doingwork.work/docs/reference/quotes-pdf/) | A 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 total | Agents can call this | | [customers.setAutopay](https://doingwork.work/docs/reference/customers-setautopay/) | Turn auto-pay on or off for a customer (owner or office) | Agents can call this | | [shops.setTaxReportBasis](https://doingwork.work/docs/reference/shops-settaxreportbasis/) | Choose how the sales tax report counts a period (owner only) | Agents can call this | | [quotes.addAttachment](https://doingwork.work/docs/reference/quotes-addattachment/) | Show an uploaded photo or file of the same job with a quote, with an optional caption | Agents can call this | | [quotes.removeAttachment](https://doingwork.work/docs/reference/quotes-removeattachment/) | Take a photo or file off a quote | Agents can call this | | [quotes.listAttachments](https://doingwork.work/docs/reference/quotes-listattachments/) | Photos and files shown with a quote, in order | Agents can call this | | [media.tag](https://doingwork.work/docs/reference/media-tag/) | Add or remove tags on a photo (for example: leak, panel, permit) | Agents can call this | | [media.search](https://doingwork.work/docs/reference/media-search/) | Find photos across the shop that carry all the given tags | Agents can call this | | [jobs.findByTag](https://doingwork.work/docs/reference/jobs-findbytag/) | Jobs in the shop that carry all the given tags (set with jobs.setTags), newest first, up to 200 | Agents can call this | | [media.saveMarkup](https://doingwork.work/docs/reference/media-savemarkup/) | Save 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.getMarkup](https://doingwork.work/docs/reference/media-getmarkup/) | A photo's markup: the latest version unless one is named, with an SVG overlay to lay over the original photo | Agents can call this | | [webhooks.deliveries](https://doingwork.work/docs/reference/webhooks-deliveries/) | List deliveries to one webhook endpoint, newest first, with event, status, attempts and last HTTP status | Agents can call this | | [webhooks.retry](https://doingwork.work/docs/reference/webhooks-retry/) | Send a failed or dead delivery again from attempt 0 (owner or office) | Agents can call this | | [shops.export](https://doingwork.work/docs/reference/shops-export/) | Owner only: everything the shop holds as one ZIP: data/.csv and data/
.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.json | Agents can call this | | [members.permissions](https://doingwork.work/docs/reference/members-permissions/) | What each current worker in a shop may do beyond their role: see_prices, see_costs, take_money, delete and manage_schedule | Agents can call this | | [members.setPermissions](https://doingwork.work/docs/reference/members-setpermissions/) | Owner only, not an agent: turn a worker's permissions on or off | A person's own sign-in only | | [shops.sendPermissions](https://doingwork.work/docs/reference/shops-sendpermissions/) | What each role may send to a customer: quotes, invoices and visit recaps | Agents can call this | | [shops.setSendPermissions](https://doingwork.work/docs/reference/shops-setsendpermissions/) | Owner 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.signUp](https://doingwork.work/docs/reference/shops-signup/) | Create a shop for an owner who has already accepted the current Terms and Privacy | Agents can call this | | [jobs.complete](https://doingwork.work/docs/reference/jobs-complete/) | Mark a job done (owner or office) | Agents can call this | | [notifications.getPrefs](https://doingwork.work/docs/reference/notifications-getprefs/) | How 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.setPrefs](https://doingwork.work/docs/reference/notifications-setprefs/) | Turn mention emails or texts, or the night-before kit list email, on or off for yourself in one shop | Agents can call this | | [crews.save](https://doingwork.work/docs/reference/crews-save/) | Save a named crew of workers to book together (owner or office) | Agents can call this | | [crews.list](https://doingwork.work/docs/reference/crews-list/) | The shop's crews and their current workers | Agents can call this | | [crews.archive](https://doingwork.work/docs/reference/crews-archive/) | Archive a crew (owner or office) | Agents can call this | | [financing.save](https://doingwork.work/docs/reference/financing-save/) | Save a financing link the shop works with, shown on quotes at or above its minimum (owner or office) | Agents can call this | | [financing.list](https://doingwork.work/docs/reference/financing-list/) | The shop's financing links | Agents can call this | | [financing.archive](https://doingwork.work/docs/reference/financing-archive/) | Archive a financing link so it no longer shows on quotes (owner or office) | Agents can call this | | [tasks.create](https://doingwork.work/docs/reference/tasks-create/) | Make 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.list](https://doingwork.work/docs/reference/tasks-list/) | Tasks 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.update](https://doingwork.work/docs/reference/tasks-update/) | Change a task's title, job, worker or due time (due_on or due_at; null clears it) | Agents can call this | | [tasks.close](https://doingwork.work/docs/reference/tasks-close/) | Close a task as done (default) or cancelled, with an optional note | Agents can call this | | [quotes.search](https://doingwork.work/docs/reference/quotes-search/) | Search 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 sent | Agents can call this | | [jobs.brief](https://doingwork.work/docs/reference/jobs-brief/) | Everything 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 quotes | Agents can call this | | [corrections.record](https://doingwork.work/docs/reference/corrections-record/) | Save 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.recent](https://doingwork.work/docs/reference/corrections-recent/) | The shop's recent corrections to drafts you made, newest first: what was changed or rejected and why | Agents can call this | | [quotes.draftFromVisit](https://doingwork.work/docs/reference/quotes-draftfromvisit/) | Draft quote lines from a visit, in the worker's words and what you saw and heard | Agents can call this | | [quotes.draft](https://doingwork.work/docs/reference/quotes-draft/) | Read one AI line draft from quotes.draftFromVisit, not a customer quote | Agents can call this | | [quotes.decideDraftLine](https://doingwork.work/docs/reference/quotes-decidedraftline/) | Record the worker's call on one drafted line: approve it (with any change they made to the words, quantity, price or basis) or reject it | Agents can call this | | [quotes.finishDraft](https://doingwork.work/docs/reference/quotes-finishdraft/) | Make the quote from a draft once the worker decided every line | Agents can call this | | [quotes.comparables](https://doingwork.work/docs/reference/quotes-comparables/) | Past prices related to one new line, for you to price it | Agents can call this | | [shops.setPricingRules](https://doingwork.work/docs/reference/shops-setpricingrules/) | Save the owner's pricing rules for their assistant, in their own words (owner only) | Agents can call this | | [shops.visitSteps](https://doingwork.work/docs/reference/shops-visitsteps/) | The shop's guided visit steps, in order: the eight defaults until the shop edits them | Agents can call this | | [shops.setVisitSteps](https://doingwork.work/docs/reference/shops-setvisitsteps/) | Replace the shop's guided visit steps: add, remove, rename or reorder by sending the full list | Agents can call this | | [customers.winBack](https://doingwork.work/docs/reference/customers-winback/) | Win-back list: customers with no visit in `months` (default 18; imported visits count), leaving out anyone with an open job or a visit coming up | Agents can call this | | [customers.winBackQueue](https://doingwork.work/docs/reference/customers-winbackqueue/) | Send 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 rules | Agents can call this | | [invoices.createFromTm](https://doingwork.work/docs/reference/invoices-createfromtm/) | Bill 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 markup | Agents can call this | | [customers.audience](https://doingwork.work/docs/reference/customers-audience/) | Pick 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 customers | Agents can call this | | [stock.setLevel](https://doingwork.work/docs/reference/stock-setlevel/) | Track 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.adjust](https://doingwork.work/docs/reference/stock-adjust/) | Record stock received, used, returned, lost or adjusted for a tracked material | Agents can call this | | [stock.list](https://doingwork.work/docs/reference/stock-list/) | Tracked materials with the count on hand and low point | Agents can call this | | [stock.moves](https://doingwork.work/docs/reference/stock-moves/) | Stock history for one tracked material, newest first: every count, receipt, use, return, loss and adjustment with who and when | Agents can call this | | [services.addDue](https://doingwork.work/docs/reference/services-adddue/) | Record when a customer's next service is due (owner or office), for example a yearly furnace tune-up | Agents can call this | | [services.listDue](https://doingwork.work/docs/reference/services-listdue/) | List service due dates for the shop, soonest first | Agents can call this | | [services.updateDue](https://doingwork.work/docs/reference/services-updatedue/) | Change an open service due date's title, date or repeat (owner or office) | Agents can call this | | [services.completeDue](https://doingwork.work/docs/reference/services-completedue/) | Mark a service due date done (owner or office) | Agents can call this | | [services.cancelDue](https://doingwork.work/docs/reference/services-canceldue/) | Cancel an open service due date (owner or office), for example when the customer no longer wants the service | Agents can call this | | [shops.setServiceDueEmails](https://doingwork.work/docs/reference/shops-setservicedueemails/) | Turn "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.getPeriod](https://doingwork.work/docs/reference/payroll-getperiod/) | The shop's pay period setting (weekly, biweekly, semimonthly or monthly) and the current period's dates | Agents can call this | | [payroll.setPeriod](https://doingwork.work/docs/reference/payroll-setperiod/) | Owner or office: set the pay period | Agents can call this | | [payroll.hours](https://doingwork.work/docs/reference/payroll-hours/) | Payroll-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 running | Agents can call this | | [payroll.exportCsv](https://doingwork.work/docs/reference/payroll-exportcsv/) | Approved 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.transferStart](https://doingwork.work/docs/reference/shops-transferstart/) | Start handing the shop to a current worker (owner, on a hosted page) | Hosted page only | | [shops.transferAccept](https://doingwork.work/docs/reference/shops-transferaccept/) | Accept a hand-off and become the shop's owner (the person asked, on a hosted page) | Hosted page only | | [shops.transferCancel](https://doingwork.work/docs/reference/shops-transfercancel/) | Stop an open hand-off: the owner cancels it, or the person asked declines it | Agents can call this | | [shops.transfers](https://doingwork.work/docs/reference/shops-transfers/) | Hand-offs of a shop, newest first | Agents can call this | | [shops.closeCheck](https://doingwork.work/docs/reference/shops-closecheck/) | Whether the shop can close now (owner only) | Agents can call this | | [shops.close](https://doingwork.work/docs/reference/shops-close/) | Close the shop for good (owner, on a hosted page, typing the shop name) | Hosted page only | | [shops.reopen](https://doingwork.work/docs/reference/shops-reopen/) | Reopen a closed shop (only the owner who closed it, on a hosted page, within 90 days of closing) | Hosted page only | | [invoices.void](https://doingwork.work/docs/reference/invoices-void/) | Void an invoice nobody has paid yet (owner or office), with a reason | Agents can call this | | [network.info](https://doingwork.work/docs/reference/network-info/) | What the customer quote network covers: the area, the trades and the rules | Agents can call this | | [network.listingSet](https://doingwork.work/docs/reference/network-listingset/) | Turn 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.setAgentOptIn](https://doingwork.work/docs/reference/network-setagentoptin/) | Let 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.listingGet](https://doingwork.work/docs/reference/network-listingget/) | A shop's customer request settings (owner or office) | Agents can call this | | [network.inbox](https://doingwork.work/docs/reference/network-inbox/) | Customer 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.photo](https://doingwork.work/docs/reference/network-photo/) | One photo from a customer request, as base64 JPEG, PNG or WebP with location data removed | Agents can call this | | [network.reply](https://doingwork.work/docs/reference/network-reply/) | Answer a customer request with the shop's own quote: lines and prices your workers wrote, and the deposit you want when the customer books | Agents can call this | | [network.decline](https://doingwork.work/docs/reference/network-decline/) | Pass on a customer request (owner or office) | Agents can call this | | [network.markArrived](https://doingwork.work/docs/reference/network-markarrived/) | Record that the shop showed up for a booked customer job (owner or office) | Agents can call this | | [network.cancelBooking](https://doingwork.work/docs/reference/network-cancelbooking/) | Cancel a booked customer job (owner or office) | Agents can call this | | [homeowner.webhookCreate](https://doingwork.work/docs/reference/homeowner-webhookcreate/) | Add a webhook so your own assistant hears about your requests: homeowner.reply_received, homeowner.booking_changed, homeowner.dispute_decided and homeowner.request_delivered | Agents can call this | | [homeowner.webhookList](https://doingwork.work/docs/reference/homeowner-webhooklist/) | Your webhooks | Agents can call this | | [homeowner.webhookDelete](https://doingwork.work/docs/reference/homeowner-webhookdelete/) | Remove one of your webhooks | Agents can call this | | [homeowner.createRequest](https://doingwork.work/docs/reference/homeowner-createrequest/) | Start 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 need | Agents can call this | | [homeowner.addPhoto](https://doingwork.work/docs/reference/homeowner-addphoto/) | Add one photo (base64 JPEG, PNG, WebP, HEIC or TIFF) to a request you have not sent yet | Agents can call this | | [homeowner.previewShops](https://doingwork.work/docs/reference/homeowner-previewshops/) | Before sending, list the shops on Doing Work that would get your request, each with why it matches | Agents can call this | | [homeowner.updateRequest](https://doingwork.work/docs/reference/homeowner-updaterequest/) | Change a request you have not sent yet: the trade, category, address, title or details | Agents can call this | | [homeowner.sendRequest](https://doingwork.work/docs/reference/homeowner-sendrequest/) | Send your request to shops on Doing Work that serve the address and do the trade | Agents can call this | | [homeowner.getRequest](https://doingwork.work/docs/reference/homeowner-getrequest/) | Your request and every reply so far | Agents can call this | | [homeowner.listRequests](https://doingwork.work/docs/reference/homeowner-listrequests/) | Your customer requests, newest first | Agents can call this | | [homeowner.withdrawRequest](https://doingwork.work/docs/reference/homeowner-withdrawrequest/) | Withdraw a request you have not booked | Agents can call this | | [homeowner.pickReply](https://doingwork.work/docs/reference/homeowner-pickreply/) | Book one shop's reply | Agents can call this | | [homeowner.reportNoShow](https://doingwork.work/docs/reference/homeowner-reportnoshow/) | Tell Doing Work the shop you booked did not show up | Agents can call this | | [network.disputeStatement](https://doingwork.work/docs/reference/network-disputestatement/) | Tell Doing Work your side of a disputed no-show on a customer booking (owner or office) | Agents can call this | | [network.claimGuestQuote](https://doingwork.work/docs/reference/network-claimguestquote/) | For a shop that quoted a job from an outreach link before it had an account: bring that job into your shop's request inbox | Agents can call this | | [phone.consents](https://doingwork.work/docs/reference/phone-consents/) | Consent history and stop status for one customer phone number in the shop: every grant, confirmation and revoke, oldest first | Agents can call this | | [phone.stop](https://doingwork.work/docs/reference/phone-stop/) | Put a customer's number on the shop's stop list, for example when they asked out loud not to be texted or called | Agents can call this | | [phone.connectTwilio](https://doingwork.work/docs/reference/phone-connecttwilio/) | Connect the shop's own Twilio account | Agents can call this | | [phone.twilioNumbers](https://doingwork.work/docs/reference/phone-twilionumbers/) | The phone numbers in the shop's connected Twilio account, and whether each one already sends its calls or texts somewhere else | Agents can call this | | [phone.useNumber](https://doingwork.work/docs/reference/phone-usenumber/) | Use one number from the shop's Twilio account for the shop's texts and calls | Agents can call this | | [phone.setRoute](https://doingwork.work/docs/reference/phone-setroute/) | Change 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 inbox | Agents can call this | | [phone.status](https://doingwork.work/docs/reference/phone-status/) | Whether the shop has Twilio connected and which number it uses, how calls are answered, and the texting registration status | Agents can call this | | [phone.disconnect](https://doingwork.work/docs/reference/phone-disconnect/) | Disconnect the shop's Twilio account | Agents can call this | | [phone.calls](https://doingwork.work/docs/reference/phone-calls/) | Recent calls to the shop number, newest first: who called, whether it was answered, went to voicemail or was missed, and the voicemail link | Agents can call this | | [phone.threads](https://doingwork.work/docs/reference/phone-threads/) | Text threads with customers, newest first | Agents can call this | | [phone.thread](https://doingwork.work/docs/reference/phone-thread/) | The messages on one text thread, oldest first | Agents can call this | | [phone.takeThread](https://doingwork.work/docs/reference/phone-takethread/) | Take 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 it | Hosted page only | | [phone.resumeThread](https://doingwork.work/docs/reference/phone-resumethread/) | Owner only: start texts again on a thread that was paused because the customer wrote something stop-like | Agents can call this | | [phone.sendText](https://doingwork.work/docs/reference/phone-sendtext/) | Text a customer from the shop number, about their job | Agents can call this | | [phone.registrationStatus](https://doingwork.work/docs/reference/phone-registrationstatus/) | Check the shop's texting registration with Twilio and save it: unregistered, brand_pending, campaign_pending, tollfree_pending, approved or failed, with the next step | Agents can call this | | [phone.portStatus](https://doingwork.work/docs/reference/phone-portstatus/) | Where a request to move (port) the shop's existing number into its Twilio account stands, with the next step | Agents can call this | | [phone.setVoiceAi](https://doingwork.work/docs/reference/phone-setvoiceai/) | Set up the shop's own voice AI agent to answer calls: provider (elevenlabs or grok) and the agent's SIP address | Agents can call this | | [phone.setEmergency](https://doingwork.work/docs/reference/phone-setemergency/) | How the shop's voice agent handles emergency calls | Agents can call this | | [phone.emergency](https://doingwork.work/docs/reference/phone-emergency/) | How the shop's voice agent handles emergency calls, with suggested trigger words | Agents can call this | | [phone.voiceAi](https://doingwork.work/docs/reference/phone-voiceai/) | The shop's voice AI setup: provider, SIP address, whether a webhook secret is set (never the secret), and the URLs to give the provider | Agents can call this | | [phone.voiceJobTypes](https://doingwork.work/docs/reference/phone-voicejobtypes/) | Job 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 them | Agents can call this | | [phone.saveVoiceJobType](https://doingwork.work/docs/reference/phone-savevoicejobtype/) | Add 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_minor | Agents can call this | | [phone.archiveVoiceJobType](https://doingwork.work/docs/reference/phone-archivevoicejobtype/) | Stop the voice agent booking a job type | Agents can call this | | [phone.setOutboundAi](https://doingwork.work/docs/reference/phone-setoutboundai/) | Turn the shop's outbound AI calls on or off | Agents can call this | | [phone.callCustomer](https://doingwork.work/docs/reference/phone-callcustomer/) | Ask 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.outboundCalls](https://doingwork.work/docs/reference/phone-outboundcalls/) | Recent 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.due](https://doingwork.work/docs/reference/agent-due/) | Follow-ups the agent scheduled for itself that are due now (tasks.create with for_agent) | Agents can call this | | [agent.checkup](https://doingwork.work/docs/reference/agent-checkup/) | A 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 due | Agents can call this | | [agent.snooze](https://doingwork.work/docs/reference/agent-snooze/) | Hide one checkup suggestion so it is not repeated | Agents can call this | | [agent.emitNudge](https://doingwork.work/docs/reference/agent-emitnudge/) | Emit 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 shop | Agents can call this | | [sync.setRef](https://doingwork.work/docs/reference/sync-setref/) | Record 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 duplicate | Agents can call this | | [sync.findRefs](https://doingwork.work/docs/reference/sync-findrefs/) | List outside ids a shop has recorded for one system | Agents can call this | | [sync.changes](https://doingwork.work/docs/reference/sync-changes/) | Invoices, payments, refunds and customers that changed since a time or cursor, oldest change first, each with its current details and outside ids | Agents can call this | | [payouts.list](https://doingwork.work/docs/reference/payouts-list/) | A shop's payouts to its bank, newest first, so an agent can match each bank deposit | Agents can call this | | [payouts.get](https://doingwork.work/docs/reference/payouts-get/) | One payout broken down: each payment and refund in it, the processor fee and the Doing Work fee on each, and the net | Agents can call this | | [books.export](https://doingwork.work/docs/reference/books-export/) | Owner 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 account | Agents can call this | | [books.exports](https://doingwork.work/docs/reference/books-exports/) | Owner 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.linesFromTasks](https://doingwork.work/docs/reference/quotes-linesfromtasks/) | Turn the flat rate tasks a worker picked into quote lines for quotes.create: shared tasks, or tasks per good, better, best option | Agents can call this | | [shops.setPriceStaleDays](https://doingwork.work/docs/reference/shops-setpricestaledays/) | Set how many days old a price book price may be before it shows as stale (owner or office) | Agents can call this | | [me.smsConsent](https://doingwork.work/docs/reference/me-smsconsent/) | Check your current SMS consent status for Doing Work alerts and check-ins, and get the hosted /p/account/sms opt-in link | Agents can call this | | [me.setSmsConsent](https://doingwork.work/docs/reference/me-setsmsconsent/) | Grant or revoke Doing Work SMS alerts and check-in consent for the signed-in person | Hosted page only | ## Team (unlimited workers) | Operation | What it does | Who | |---|---|---| | [members.invite](https://doingwork.work/docs/reference/members-invite/) | Invite a person by email as office, lead or field | Agents can call this | | [members.accept](https://doingwork.work/docs/reference/members-accept/) | Accept an invite as the signed-in person | Agents can call this | | [members.list](https://doingwork.work/docs/reference/members-list/) | Current members of a shop with role and start date | Agents can call this | | [members.end](https://doingwork.work/docs/reference/members-end/) | End a membership: the owner removes a worker, or a worker leaves | Agents can call this | | [members.changeRole](https://doingwork.work/docs/reference/members-changerole/) | Owner changes a worker among office, lead and field | Agents can call this | | [approvals.setRule](https://doingwork.work/docs/reference/approvals-setrule/) | Owner only, not an agent: require owner approval before an agent can run an action | A person's own sign-in only | | [approvals.removeRule](https://doingwork.work/docs/reference/approvals-removerule/) | Owner only, not an agent: stop requiring approval for a rule | A person's own sign-in only | | [approvals.listRules](https://doingwork.work/docs/reference/approvals-listrules/) | The shop's approval rules: which agent actions wait for the owner | Agents can call this | | [approvals.list](https://doingwork.work/docs/reference/approvals-list/) | Approval requests for a shop, newest first, optionally by status (pending, approved, denied, failed, expired) | Agents can call this | | [approvals.get](https://doingwork.work/docs/reference/approvals-get/) | One approval request with its status and, once approved and run, the action's result | Agents can call this | | [approvals.decide](https://doingwork.work/docs/reference/approvals-decide/) | Owner only, not an agent: approve or deny a pending agent action | A person's own sign-in only | ## Customers | Operation | What it does | Who | |---|---|---| | [customers.create](https://doingwork.work/docs/reference/customers-create/) | Add a customer to a shop, with kind, company, email, phone, billing address, lead source, tags and notes in one call | Agents can call this | | [properties.add](https://doingwork.work/docs/reference/properties-add/) | Add a service address to a customer, with optional label and access notes | Agents can call this | | [properties.list](https://doingwork.work/docs/reference/properties-list/) | Service 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 here | Agents can call this | | [properties.update](https://doingwork.work/docs/reference/properties-update/) | Change a property's label or access notes, or archive it | Agents can call this | | [equipment.add](https://doingwork.work/docs/reference/equipment-add/) | Record equipment at a property: kind, make, model, serial, install date and warranty | Agents can call this | | [equipment.list](https://doingwork.work/docs/reference/equipment-list/) | Equipment at a property, or warranties ending soon across a shop | Agents can call this | | [equipment.update](https://doingwork.work/docs/reference/equipment-update/) | Change or archive an equipment record | Agents can call this | ## Jobs (unlimited) | Operation | What it does | Who | |---|---|---| | [jobs.create](https://doingwork.work/docs/reference/jobs-create/) | Start 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.list](https://doingwork.work/docs/reference/jobs-list/) | Jobs of a shop you belong to, newest first | Agents can call this | | [jobs.get](https://doingwork.work/docs/reference/jobs-get/) | One job with its home address and, when it was converted from a request, that request | Agents can call this | ## Job photos | Operation | What it does | Who | |---|---|---| | [media.requestUpload](https://doingwork.work/docs/reference/media-requestupload/) | Get a signed upload URL for a job photo or video | Agents can call this | | [media.requestCapture](https://doingwork.work/docs/reference/media-requestcapture/) | Hosted photo capture: a signed upload URL for a worker taking a photo in the browser | Hosted page only | | [media.list](https://doingwork.work/docs/reference/media-list/) | List 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 details | Agents can call this | | [media.get](https://doingwork.work/docs/reference/media-get/) | One 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 file | Agents can call this | | [shares.create](https://doingwork.work/docs/reference/shares-create/) | Make a link to a gallery of a job's photos that anyone with the link can open without signing in | Agents can call this | | [shares.list](https://doingwork.work/docs/reference/shares-list/) | Photo share links on a job, newest first, with whether each is still active and how often it was opened | Agents can call this | | [shares.revoke](https://doingwork.work/docs/reference/shares-revoke/) | Turn a photo share link off now | Agents can call this | ## Quotes (unlimited) | Operation | What it does | Who | |---|---|---| | [quotes.create](https://doingwork.work/docs/reference/quotes-create/) | Create 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.send](https://doingwork.work/docs/reference/quotes-send/) | Lock 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.sign](https://doingwork.work/docs/reference/quotes-sign/) | Sign a quote after accepting electronic signing and typing a name | Hosted page only | | [quotes.revise](https://doingwork.work/docs/reference/quotes-revise/) | Pass the COMPLETE new line list; any line you omit is removed | Agents can call this | | [pricebook.saveItem](https://doingwork.work/docs/reference/pricebook-saveitem/) | Add a price book item, or change one when item_id is given (owner or office) | Agents can call this | | [pricebook.list](https://doingwork.work/docs/reference/pricebook-list/) | List the shop's price book items, by name | Agents can call this | | [pricebook.archiveItem](https://doingwork.work/docs/reference/pricebook-archiveitem/) | Archive a price book item, or bring it back with archived false (owner or office) | Agents can call this | | [pricebook.taskCost](https://doingwork.work/docs/reference/pricebook-taskcost/) | What 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.importPrices](https://doingwork.work/docs/reference/pricebook-importprices/) | Import 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.priceHistory](https://doingwork.work/docs/reference/pricebook-pricehistory/) | The dated prices saved for one price book item, newest effective date first (owner or office, needs see_prices) | Agents can call this | | [pricebook.stalePrices](https://doingwork.work/docs/reference/pricebook-staleprices/) | Price 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) | Operation | What it does | Who | |---|---|---| | [invoices.createFromQuote](https://doingwork.work/docs/reference/invoices-createfromquote/) | Create an invoice for a signed quote, for the total of the option and optional lines the customer picked | Agents can call this | | [invoices.send](https://doingwork.work/docs/reference/invoices-send/) | Send an invoice (or the next part of it) and get a single-use pay link | Agents can call this | | [invoices.pay](https://doingwork.work/docs/reference/invoices-pay/) | Start paying an invoice (hosted page) | Hosted page only | | [invoices.markPaidOutside](https://doingwork.work/docs/reference/invoices-markpaidoutside/) | Record that the customer paid an invoice outside Doing Work (check, cash, financing, insurance or other) | Agents can call this | | [invoices.refund](https://doingwork.work/docs/reference/invoices-refund/) | Refund part or all of a payment (owner or office, or their agent) | Agents can call this | | [taxes.saveRate](https://doingwork.work/docs/reference/taxes-saverate/) | Add or change a sales tax rate the shop charges in one jurisdiction (owner or office) | Agents can call this | | [taxes.listRates](https://doingwork.work/docs/reference/taxes-listrates/) | The shop's tax rates | Agents can call this | | [taxes.archiveRate](https://doingwork.work/docs/reference/taxes-archiverate/) | Stop using a tax rate (owner or office) | Agents can call this | | [taxes.salesReport](https://doingwork.work/docs/reference/taxes-salesreport/) | Sales tax report for a period (owner or office), shop local dates, from and to inclusive | Agents can call this | ## Stripe connection | Operation | What it does | Who | |---|---|---| | [payments.connectStart](https://doingwork.work/docs/reference/payments-connectstart/) | Start payment setup for a shop (owner, hosted page) | Hosted page only | | [cards.setupLink](https://doingwork.work/docs/reference/cards-setuplink/) | Get a secure page where the customer saves a card with the shop's payment processor (owner or office) | Agents can call this | | [cards.resave](https://doingwork.work/docs/reference/cards-resave/) | Open the card saving page from a save-your-card-again email link (hosted page only) | Hosted page only | | [cards.get](https://doingwork.work/docs/reference/cards-get/) | The card a customer has on file (brand, last 4, expiry) and whether auto-pay is on (owner or office) | Agents can call this | | [cards.remove](https://doingwork.work/docs/reference/cards-remove/) | Remove a customer's saved card (owner or office) | Agents can call this | ## Idaho compliance | Operation | What it does | Who | |---|---|---| | [subcontractors.get](https://doingwork.work/docs/reference/subcontractors-get/) | The Idaho 45-525(3) subcontractor and supplier statement for a job: the latest signed one, any prepared draft, and whether final payment needs one | Agents can call this | | [subcontractors.prepare](https://doingwork.work/docs/reference/subcontractors-prepare/) | Prepare 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.sign](https://doingwork.work/docs/reference/subcontractors-sign/) | The 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 draft | Hosted page only | ## Signed job records | Operation | What it does | Who | |---|---|---| | [jobs.requestConfirmation](https://doingwork.work/docs/reference/jobs-requestconfirmation/) | Get a single-use link the customer opens to confirm the work was done (or flag a problem) | Agents can call this | | [jobs.confirm](https://doingwork.work/docs/reference/jobs-confirm/) | Customer confirms the work or flags a problem (hosted page) | Hosted page only | | [records.keys](https://doingwork.work/docs/reference/records-keys/) | Public keys that verify signed job records | Agents can call this | | [jobs.record](https://doingwork.work/docs/reference/jobs-record/) | The latest signed record for a job and its level (logged, paid, verified) | Agents can call this | | [documents.photoReport](https://doingwork.work/docs/reference/documents-photoreport/) | Render 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 tags | Agents can call this | | [documents.dailyLog](https://doingwork.work/docs/reference/documents-dailylog/) | Render 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 attached | Agents can call this | | [documents.list](https://doingwork.work/docs/reference/documents-list/) | PDF documents core made for a job (photo reports, daily logs and submitted forms), newest first, with each file's sha256 | Agents can call this | | [documents.get](https://doingwork.work/docs/reference/documents-get/) | One stored job PDF (base64) with its sha256, byte for byte as it was made | Agents can call this | ## Plans and fees | Operation | What it does | Who | |---|---|---| | [fees.statement](https://doingwork.work/docs/reference/fees-statement/) | A 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 | Operation | What it does | Who | |---|---|---| | [webhooks.create](https://doingwork.work/docs/reference/webhooks-create/) | Add a webhook endpoint for a shop (owner or office, or their agent) | Agents can call this | | [webhooks.list](https://doingwork.work/docs/reference/webhooks-list/) | List a shop's webhook endpoints and their recent delivery counts | Agents can call this | | [webhooks.delete](https://doingwork.work/docs/reference/webhooks-delete/) | Remove a webhook endpoint | Agents can call this | | [platforms.create](https://doingwork.work/docs/reference/platforms-create/) | Create a developer platform account (private beta) | Agents can call this | | [platforms.list](https://doingwork.work/docs/reference/platforms-list/) | List 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.shops | Agents can call this | | [platforms.grantManage](https://doingwork.work/docs/reference/platforms-grantmanage/) | Let a platform manage this shop | Hosted page only | | [platforms.revokeManage](https://doingwork.work/docs/reference/platforms-revokemanage/) | Stop a platform from managing this shop | Agents can call this | | [events.catalog](https://doingwork.work/docs/reference/events-catalog/) | Every event a webhook can receive, with its payload keys and types | Agents can call this | ## Scheduling and visits | Operation | What it does | Who | |---|---|---| | [visits.createRecurring](https://doingwork.work/docs/reference/visits-createrecurring/) | Book a repeating visit (daily, weekly or monthly, every n) for a job | Agents can call this | | [visits.cancelSeries](https://doingwork.work/docs/reference/visits-cancelseries/) | Cancel the visits of a repeating series that have not started yet, from a time onward (default now) | Agents can call this | | [visits.start](https://doingwork.work/docs/reference/visits-start/) | Mark a visit started (from scheduled, on the way, or arrived) | Agents can call this | | [visits.done](https://doingwork.work/docs/reference/visits-done/) | Mark a visit done, with an optional note | Agents can call this | | [visits.create](https://doingwork.work/docs/reference/visits-create/) | Book 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.update](https://doingwork.work/docs/reference/visits-update/) | Move a visit or change its title, notes or arrival window | Agents can call this | | [visits.assign](https://doingwork.work/docs/reference/visits-assign/) | Set who is going on a visit: person_ids, a saved crew_id, or both | Agents can call this | | [visits.cancel](https://doingwork.work/docs/reference/visits-cancel/) | Cancel a visit that is scheduled, on the way, or arrived | Agents can call this | | [visits.setPriority](https://doingwork.work/docs/reference/visits-setpriority/) | Set a visit's priority: normal, urgent or emergency | Agents can call this | | [visits.get](https://doingwork.work/docs/reference/visits-get/) | One visit with its job and workers | Agents can call this | | [schedule.list](https://doingwork.work/docs/reference/schedule-list/) | A shop's visits that overlap a time window, earliest first | Agents can call this | | [availability.setHours](https://doingwork.work/docs/reference/availability-sethours/) | Set a worker's weekly hours, replacing what was there | Agents can call this | | [availability.addTimeOff](https://doingwork.work/docs/reference/availability-addtimeoff/) | Add time off for a worker (vacation, sick, appointment) | Agents can call this | | [availability.removeTimeOff](https://doingwork.work/docs/reference/availability-removetimeoff/) | Remove a time-off entry | Agents can call this | | [availability.get](https://doingwork.work/docs/reference/availability-get/) | A worker's weekly hours, time off, and booked visits in a window (at most 62 days) | Agents can call this | | [schedule.settings](https://doingwork.work/docs/reference/schedule-settings/) | The 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 shown | Agents can call this | | [schedule.setShopHours](https://doingwork.work/docs/reference/schedule-setshophours/) | Set the shop's booking hours, replacing what was there (owner or office) | Agents can call this | | [schedule.setRules](https://doingwork.work/docs/reference/schedule-setrules/) | Change the shop's scheduling rules (owner or office; the time zone is owner only) | Agents can call this | | [schedule.findTime](https://doingwork.work/docs/reference/schedule-findtime/) | Find 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.onTheWay](https://doingwork.work/docs/reference/visits-ontheway/) | Mark 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.arrived](https://doingwork.work/docs/reference/visits-arrived/) | Mark that the worker arrived at a visit | Agents can call this | | [visits.notices](https://doingwork.work/docs/reference/visits-notices/) | Customer 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 why | Agents can call this | | [schedule.openSlots](https://doingwork.work/docs/reference/schedule-openslots/) | Times the shop marked open for its voice agent to book (upcoming only), and which are booked | Agents can call this | | [schedule.addOpenSlots](https://doingwork.work/docs/reference/schedule-addopenslots/) | Mark times open for the shop's voice agent to book callers into (owner or office) | Agents can call this | | [schedule.removeOpenSlot](https://doingwork.work/docs/reference/schedule-removeopenslot/) | Take back an open time that is not booked yet (owner or office) | Agents can call this | | [schedule.bookingPage](https://doingwork.work/docs/reference/schedule-bookingpage/) | Read 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.setBookingPage](https://doingwork.work/docs/reference/schedule-setbookingpage/) | Configure the shop's hosted public booking page (/p/book/) for Google Business Profile and Google Actions Center | Agents can call this | | [maintenance.createPlan](https://doingwork.work/docs/reference/maintenance-createplan/) | Start a maintenance plan for a job's customer (owner or office) | Agents can call this | | [maintenance.getPlan](https://doingwork.work/docs/reference/maintenance-getplan/) | One maintenance plan: price per term, current term, renewal date, each term's invoice, and this term's covered visits with the next one due | Agents can call this | | [maintenance.listPlans](https://doingwork.work/docs/reference/maintenance-listplans/) | A shop's maintenance plans, optionally for one customer or by status, soonest renewal first | Agents can call this | | [maintenance.setPrice](https://doingwork.work/docs/reference/maintenance-setprice/) | Replace a plan's priced lines (owner or office), and optionally its tax rate | Agents can call this | | [maintenance.confirmPrice](https://doingwork.work/docs/reference/maintenance-confirmprice/) | Apply an agent's proposed price on a maintenance plan | A person's own sign-in only | | [maintenance.setVisits](https://doingwork.work/docs/reference/maintenance-setvisits/) | Change how many visits a plan covers each term, and what they are called (owner or office) | Agents can call this | | [maintenance.cancelPlan](https://doingwork.work/docs/reference/maintenance-cancelplan/) | Cancel a maintenance plan (owner or office) | Agents can call this | | [schedule.kitList](https://doingwork.work/docs/reference/schedule-kitlist/) | The 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 photos | Agents can call this | | [schedule.setKitListEmail](https://doingwork.work/docs/reference/schedule-setkitlistemail/) | Set 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 false | Agents can call this | | [schedule.capacity](https://doingwork.work/docs/reference/schedule-capacity/) | How 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 times | Agents can call this | | [visits.brief](https://doingwork.work/docs/reference/visits-brief/) | One 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 quotes | Agents can call this | | [visits.addRecording](https://doingwork.work/docs/reference/visits-addrecording/) | Add a walkthrough recording the worker sent you, during or after the visit | Agents can call this | | [visits.recordings](https://doingwork.work/docs/reference/visits-recordings/) | Recordings on a visit, newest first: when each was recorded, what the worker said it was, the note its transcript became, and private worker_notes | Agents can call this | | [visits.draftRecap](https://doingwork.work/docs/reference/visits-draftrecap/) | Draft the recap email for the customer after a visit | Agents can call this | | [visits.editRecap](https://doingwork.work/docs/reference/visits-editrecap/) | Change the subject or words of a recap draft before the worker approves it | Agents can call this | | [visits.approveRecap](https://doingwork.work/docs/reference/visits-approverecap/) | Send the recap: it goes to the customer by email from the shop, with replies to the shop owner | Agents can call this | | [visits.steps](https://doingwork.work/docs/reference/visits-steps/) | The guided visit steps for a visit, each done, skipped, or open, and the next one to suggest | Agents can call this | | [visits.markStep](https://doingwork.work/docs/reference/visits-markstep/) | Mark a guided visit step done or skipped (or open again) when the worker says so | Agents can call this | | [schedule.route](https://doingwork.work/docs/reference/schedule-route/) | One 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.events](https://doingwork.work/docs/reference/schedule-events/) | Visits 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 later | Agents can call this | | [visits.changeRequests](https://doingwork.work/docs/reference/visits-changerequests/) | Customers' requests to move or cancel a visit, from the customer hub, newest first | Agents can call this | | [visits.answerChange](https://doingwork.work/docs/reference/visits-answerchange/) | Answer a customer's request to move or cancel a visit | Agents can call this | ## Field work (checklists, forms, time, notes, change orders, subcontractors) | Operation | What it does | Who | |---|---|---| | [logs.add](https://doingwork.work/docs/reference/logs-add/) | Write a daily log entry on a job: what happened on site that day, in the worker's own words | Agents can call this | | [logs.list](https://doingwork.work/docs/reference/logs-list/) | Daily log entries on a job, oldest first, optionally between two dates (inclusive) | Agents can call this | | [logs.remove](https://doingwork.work/docs/reference/logs-remove/) | Take a daily log entry out of the log | Agents can call this | | [signatures.request](https://doingwork.work/docs/reference/signatures-request/) | Ask someone to sign a document on a hosted page, and get the signing link to give them | Agents can call this | | [signatures.newLink](https://doingwork.work/docs/reference/signatures-newlink/) | A new signing link for an open signature request | Agents can call this | | [signatures.cancel](https://doingwork.work/docs/reference/signatures-cancel/) | Cancel an open signature request | Agents can call this | | [signatures.get](https://doingwork.work/docs/reference/signatures-get/) | One 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.list](https://doingwork.work/docs/reference/signatures-list/) | Signature requests for a job, a customer or a whole shop, newest first, with status and who signed | Agents can call this | | [signatures.sign](https://doingwork.work/docs/reference/signatures-sign/) | Sign a document after reading it, typing your name and agreeing to sign electronically | Hosted page only | | [checklists.saveTemplate](https://doingwork.work/docs/reference/checklists-savetemplate/) | Create a checklist template, or replace one (give checklist_template_id) | Agents can call this | | [checklists.listTemplates](https://doingwork.work/docs/reference/checklists-listtemplates/) | The shop's checklist templates with their items | Agents can call this | | [checklists.archiveTemplate](https://doingwork.work/docs/reference/checklists-archivetemplate/) | Archive a checklist template so it is no longer offered | Agents can call this | | [checklists.create](https://doingwork.work/docs/reference/checklists-create/) | Put a checklist on a job, or on one visit of the job (visit_id) | Agents can call this | | [checklists.list](https://doingwork.work/docs/reference/checklists-list/) | Checklists on a job (all of them, job-level and per visit) or on one visit, with counts of open required items and sign-off state | Agents can call this | | [checklists.get](https://doingwork.work/docs/reference/checklists-get/) | One checklist with every item (removed items included and marked), who ticked what and when, and its sign-off | Agents can call this | | [checklists.checkItem](https://doingwork.work/docs/reference/checklists-checkitem/) | Tick (done true) or untick an item, with an optional note | Agents can call this | | [checklists.addItems](https://doingwork.work/docs/reference/checklists-additems/) | Add items to the end of a checklist (owner or office) | Agents can call this | | [checklists.removeItem](https://doingwork.work/docs/reference/checklists-removeitem/) | Remove an item from a checklist (it stays in the history, marked removed) | Agents can call this | | [checklists.requestSignOff](https://doingwork.work/docs/reference/checklists-requestsignoff/) | Ask for a sign-off on a finished checklist and get the signing link | Agents can call this | | [forms.saveTemplate](https://doingwork.work/docs/reference/forms-savetemplate/) | Create a form template (an inspection, a safety sheet, a start-up report), or replace one (give form_template_id) | Agents can call this | | [forms.listTemplates](https://doingwork.work/docs/reference/forms-listtemplates/) | The shop's form templates with their fields | Agents can call this | | [forms.archiveTemplate](https://doingwork.work/docs/reference/forms-archivetemplate/) | Archive a form template so it is no longer offered | Agents can call this | | [forms.start](https://doingwork.work/docs/reference/forms-start/) | Start a form on a job, or on one visit of the job (visit_id) | Agents can call this | | [forms.fill](https://doingwork.work/docs/reference/forms-fill/) | Save answers on a draft form | Agents can call this | | [forms.submit](https://doingwork.work/docs/reference/forms-submit/) | Submit a draft form: every required field must be answered (forms.get lists what is missing) | Agents can call this | | [forms.cancel](https://doingwork.work/docs/reference/forms-cancel/) | Cancel a draft form (kept in history) | Agents can call this | | [forms.get](https://doingwork.work/docs/reference/forms-get/) | One form with its fields, answers, the required fields still missing, its stored PDF id and hash once submitted, and its sign-off | Agents can call this | | [forms.list](https://doingwork.work/docs/reference/forms-list/) | Forms on a job (job-level and per visit), or on one visit, newest first, without fields and answers | Agents can call this | | [forms.requestSignOff](https://doingwork.work/docs/reference/forms-requestsignoff/) | Ask for a signature on a submitted form and get the signing link (owner or office) | Agents can call this | | [notes.add](https://doingwork.work/docs/reference/notes-add/) | Write 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.addVoiceMemo](https://doingwork.work/docs/reference/notes-addvoicememo/) | Save 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 it | Agents can call this | | [notes.update](https://doingwork.work/docs/reference/notes-update/) | Change a note | Agents can call this | | [notes.remove](https://doingwork.work/docs/reference/notes-remove/) | Take a note off its record | Agents can call this | | [notes.get](https://doingwork.work/docs/reference/notes-get/) | One note you may see, with every earlier wording (history, oldest first) | Agents can call this | | [notes.list](https://doingwork.work/docs/reference/notes-list/) | Notes 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.search](https://doingwork.work/docs/reference/notes-search/) | Find notes you may see by their words, across every record in a shop | Agents can call this | | [changes.create](https://doingwork.work/docs/reference/changes-create/) | Write 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.list](https://doingwork.work/docs/reference/changes-list/) | A 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 yet | Agents can call this | | [changes.get](https://doingwork.work/docs/reference/changes-get/) | One change order with its lines, totals, status, signature and invoice | Agents can call this | | [changes.send](https://doingwork.work/docs/reference/changes-send/) | Owner or office: ask the customer to approve a change order | Agents can call this | | [changes.cancel](https://doingwork.work/docs/reference/changes-cancel/) | Cancel a draft or sent change order (its open signature request is cancelled too, so the link stops working) | Agents can call this | | [changes.invoice](https://doingwork.work/docs/reference/changes-invoice/) | Bill approved change orders on a normal invoice (draft; send it with invoices.send) | Agents can call this | | [timesheets.clockIn](https://doingwork.work/docs/reference/timesheets-clockin/) | Start a person's clock: on a job (work), or drive, shop or break time | Agents can call this | | [timesheets.clockOut](https://doingwork.work/docs/reference/timesheets-clockout/) | Stop a person's running clock | Agents can call this | | [timesheets.current](https://doingwork.work/docs/reference/timesheets-current/) | A person's running clock in a shop, or null when they are not clocked in | Agents can call this | | [timesheets.add](https://doingwork.work/docs/reference/timesheets-add/) | Add time after the fact (a manual entry with a start and an end, at most 24 hours) | Agents can call this | | [timesheets.update](https://doingwork.work/docs/reference/timesheets-update/) | Fix a time entry that is not approved: its start, end, category, job, visit or notes | Agents can call this | | [timesheets.void](https://doingwork.work/docs/reference/timesheets-void/) | Take back a time entry that was never approved (kept in history, no longer counted) | Agents can call this | | [timesheets.decide](https://doingwork.work/docs/reference/timesheets-decide/) | Owner or office: approve or reject stopped time entries (up to 200 at once, one shop) | Agents can call this | | [timesheets.reopen](https://doingwork.work/docs/reference/timesheets-reopen/) | Owner only: reopen approved time so it can be fixed (it goes back to waiting for approval) | Agents can call this | | [timesheets.list](https://doingwork.work/docs/reference/timesheets-list/) | Time entries in a shop between dates (the shop's time zone), or on one job, with minutes by category and by person, and approved minutes | Agents can call this | | [timesheets.setRate](https://doingwork.work/docs/reference/timesheets-setrate/) | Owner 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 out | Agents can call this | | [timesheets.listRates](https://doingwork.work/docs/reference/timesheets-listrates/) | Labor cost rates in force now: the shop default and each worker's own, plus upcoming ones | Agents can call this | | [materials.add](https://doingwork.work/docs/reference/materials-add/) | Record 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.update](https://doingwork.work/docs/reference/materials-update/) | Change a recorded material's quantity, visit or notes | Agents can call this | | [materials.remove](https://doingwork.work/docs/reference/materials-remove/) | Remove a recorded material (recorded in error or returned) | Agents can call this | | [materials.list](https://doingwork.work/docs/reference/materials-list/) | Materials recorded on a job (or one visit), with the price and cost totals of those still counted | Agents can call this | | [subs.add](https://doingwork.work/docs/reference/subs-add/) | Add a subcontractor to a job: a company and the one email they will sign in with | Agents can call this | | [subs.list](https://doingwork.work/docs/reference/subs-list/) | Subcontractors on a job, or on every job in the shop: status invited, joined, expired or removed, when they last opened their page | Agents can call this | | [subs.update](https://doingwork.work/docs/reference/subs-update/) | Change a subcontractor's contact name, trade or scope note (what they see on their page) | Agents can call this | | [subs.remove](https://doingwork.work/docs/reference/subs-remove/) | Take a subcontractor off a job, for good: their link stops working at once | Agents can call this | | [subs.notes](https://doingwork.work/docs/reference/subs-notes/) | Notes subcontractors left on a job, newest first | Agents can call this | | [subs.view](https://doingwork.work/docs/reference/subs-view/) | The subcontractor's page for one job: the shop, job summary, work address, scope note, upcoming visit times and their notes | Hosted page only | | [subs.addNote](https://doingwork.work/docs/reference/subs-addnote/) | Leave 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 | Operation | What it does | Who | |---|---|---| | [requests.create](https://doingwork.work/docs/reference/requests-create/) | Log a request for work from a customer or a new lead | Agents can call this | | [requests.list](https://doingwork.work/docs/reference/requests-list/) | Requests of a shop, newest first, filtered by stage, customer or tag | Agents can call this | | [requests.pipeline](https://doingwork.work/docs/reference/requests-pipeline/) | How many open requests a shop has in each stage, and how many were won, invoiced or lost in the last 30 days | Agents can call this | | [requests.get](https://doingwork.work/docs/reference/requests-get/) | One request with its customer and the job it became | Agents can call this | | [requests.update](https://doingwork.work/docs/reference/requests-update/) | Move a request to another stage or change its details, customer or property | Agents can call this | | [requests.convert](https://doingwork.work/docs/reference/requests-convert/) | Turn a request into a job at its property or address and link them both ways | Agents can call this | | [requests.formCreate](https://doingwork.work/docs/reference/requests-formcreate/) | Turn on the shop's public request form and get its key | Agents can call this | | [requests.submitForm](https://doingwork.work/docs/reference/requests-submitform/) | Send a shop a request through its public form | Agents can call this | | [templates.save](https://doingwork.work/docs/reference/templates-save/) | Save a quote template: worker-written lines (and good, better, best options) to start quotes from | Agents can call this | | [templates.list](https://doingwork.work/docs/reference/templates-list/) | List the shop's saved quote templates with their lines | Agents can call this | | [templates.archive](https://doingwork.work/docs/reference/templates-archive/) | Archive a quote template, or bring it back with archived false (owner or office) | Agents can call this | | [requests.leadSettings](https://doingwork.work/docs/reference/requests-leadsettings/) | The 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 skip | Agents can call this | | [requests.setLeadSettings](https://doingwork.work/docs/reference/requests-setleadsettings/) | Change the shop's lead rules | Agents can call this | | [messages.templates](https://doingwork.work/docs/reference/messages-templates/) | The 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 body | Agents can call this | | [messages.saveTemplate](https://doingwork.work/docs/reference/messages-savetemplate/) | Set the subject and body wording for one kind of automatic customer email | Agents can call this | | [messages.resetTemplate](https://doingwork.work/docs/reference/messages-resettemplate/) | Go back to the built-in wording for one kind of automatic customer email | Agents can call this | | [messages.previewTemplate](https://doingwork.work/docs/reference/messages-previewtemplate/) | Show how one kind of automatic customer email reads, filled with sample customer details and the shop's name | Agents can call this | | [hub.createLink](https://doingwork.work/docs/reference/hub-createlink/) | Make 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 work | Agents can call this | | [hub.links](https://doingwork.work/docs/reference/hub-links/) | A customer's hub links, newest first: when each was made, when it expires or was revoked, and how often and when it was last opened | Agents can call this | | [hub.revokeLink](https://doingwork.work/docs/reference/hub-revokelink/) | Stop a customer hub link working, for good | Agents can call this | | [hub.view](https://doingwork.work/docs/reference/hub-view/) | The 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.open](https://doingwork.work/docs/reference/hub-open/) | Open 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 day | Hosted page only | | [hub.requestVisitChange](https://doingwork.work/docs/reference/hub-requestvisitchange/) | From the customer hub, ask the shop to move (reschedule, with the times that work better) or cancel an upcoming visit | Hosted page only | | [hub.withdrawVisitChange](https://doingwork.work/docs/reference/hub-withdrawvisitchange/) | From the customer hub, take back your own open request to move or cancel a visit | Hosted page only | | [hub.requestWork](https://doingwork.work/docs/reference/hub-requestwork/) | From the customer hub, ask the shop for new work | Hosted page only | ## Costs, expenses and reports | Operation | What it does | Who | |---|---|---| | [tips.report](https://doingwork.work/docs/reference/tips-report/) | Tips customers paid, by invoice and in total, between two dates (owner or office) | Agents can call this | | [expenses.add](https://doingwork.work/docs/reference/expenses-add/) | Record money a worker spent on a job, with the receipt photo | Agents can call this | | [expenses.update](https://doingwork.work/docs/reference/expenses-update/) | Change an expense: date, vendor, category, amount, tax, receipt photo or note | Agents can call this | | [expenses.remove](https://doingwork.work/docs/reference/expenses-remove/) | Take an expense off the books (kept in history) | Agents can call this | | [expenses.list](https://doingwork.work/docs/reference/expenses-list/) | Expenses on a job, or across the shop between dates, with totals by category | Agents can call this | | [reports.revenue](https://doingwork.work/docs/reference/reports-revenue/) | Money 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 apart | Agents can call this | | [reports.owed](https://doingwork.work/docs/reference/reports-owed/) | Money 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 days | Agents can call this | | [reports.quoteWinRate](https://doingwork.work/docs/reference/reports-quotewinrate/) | Of the quotes made between two dates (inclusive, UTC) and sent, how many were signed, declined, or are still waiting | Agents can call this | | [costs.job](https://doingwork.work/docs/reference/costs-job/) | Job 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 margin | Agents can call this | | [costs.jobs](https://doingwork.work/docs/reference/costs-jobs/) | Job costing across jobs dated between two days (inclusive, in the shop's time zone), with totals | Agents can call this | | [costs.marginAlert](https://doingwork.work/docs/reference/costs-marginalert/) | The shop's profit alert: the margin floor in percent, or null when off | Agents can call this | | [costs.setMarginAlert](https://doingwork.work/docs/reference/costs-setmarginalert/) | Set 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.today](https://doingwork.work/docs/reference/reports-today/) | The 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 yet | Agents can call this | | [reports.week](https://doingwork.work/docs/reference/reports-week/) | How 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 expenses | Agents can call this | | [reports.morningEmail](https://doingwork.work/docs/reference/reports-morningemail/) | Whether the owner's morning email is on | Agents can call this | | [reports.setMorningEmail](https://doingwork.work/docs/reference/reports-setmorningemail/) | Turn the owner's morning email on or off (owner only) | Agents can call this | | [reports.save](https://doingwork.work/docs/reference/reports-save/) | Save 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 run | Agents can call this | | [reports.listSaved](https://doingwork.work/docs/reference/reports-listsaved/) | The shop's saved reports, by name | Agents can call this | | [reports.removeSaved](https://doingwork.work/docs/reference/reports-removesaved/) | Remove a saved report (kept for the record; its name is free to use again) | Agents can call this | | [reports.run](https://doingwork.work/docs/reference/reports-run/) | Run 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 permissions | Agents can call this | ## Imports, custom fields, tags and search | Operation | What it does | Who | |---|---|---| | [fields.define](https://doingwork.work/docs/reference/fields-define/) | Add a custom field to customers, properties, jobs, quotes or invoices for a shop | Agents can call this | | [fields.list](https://doingwork.work/docs/reference/fields-list/) | Custom fields a shop has defined, optionally for one kind of record | Agents can call this | | [fields.set](https://doingwork.work/docs/reference/fields-set/) | Set one custom field value on a customer, property, job, quote or invoice | Agents can call this | | [fields.get](https://doingwork.work/docs/reference/fields-get/) | Custom field values on one record, with any required fields still empty | Agents can call this | | [tags.list](https://doingwork.work/docs/reference/tags-list/) | Every tag used in the shop, with how many photos and jobs carry it | Agents can call this | | [search.global](https://doingwork.work/docs/reference/search-global/) | Search 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.fields](https://doingwork.work/docs/reference/imports-fields/) | The customer import fields and the built-in presets (jobber, housecall_pro, servicetitan, companycam) with the export column each reads | Agents can call this | | [imports.preview](https://doingwork.work/docs/reference/imports-preview/) | Dry run of a customer CSV import | Agents can call this | | [imports.run](https://doingwork.work/docs/reference/imports-run/) | Owner only: import customers (and one service address each) from a CSV with the mapping the owner confirmed | Agents can call this | | [imports.historyFields](https://doingwork.work/docs/reference/imports-historyfields/) | Fields 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 kind | Agents can call this | | [imports.historyPreview](https://doingwork.work/docs/reference/imports-historypreview/) | Dry run of a history import (kind jobs, quotes, invoices, pricebook, equipment, maintenance_plans, payments or flat_rate) | Agents can call this | | [imports.historyRun](https://doingwork.work/docs/reference/imports-historyrun/) | Owner 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.paymentHistory](https://doingwork.work/docs/reference/imports-paymenthistory/) | Owner or office: payments imported from another system (read-only history; never charged, never counted toward Doing Work fees) | Agents can call this | | [bulk.run](https://doingwork.work/docs/reference/bulk-run/) | Run one safe action on up to 200 records: customers.addTags, customers.removeTags, customers.archive, customers.unarchive, jobs.addTags, jobs.removeTags, visits.assign | Agents can call this |