Field Service Business Platform by Doing Work

● Active

work.doingwork/shop

Headless field service software. Your AI agent runs jobs, schedules, quotes, invoices and payments.

Connect this server

One click to install, or copy the config below. Suits: Cursor · HTTP clients.

Add to Cursor Add to VS CodeClaude Desktop / Claude Code: paste the config below.

Or add it manually — claude_desktop_config.json (Claude Desktop) or .cursor/mcp.json (Cursor):

{
  "mcpServers": {
    "shop": {
      "url": "https://doingwork.work/mcp"
    }
  }
}
One line, from the terminal
Claude Code
claude mcp add --transport http shop https://doingwork.work/mcp
VS Code
code --add-mcp '{"name":"shop","type":"http","url":"https://doingwork.work/mcp"}'

Syntax from each client's docs (Claude Code: claude mcp add; Codex: codex mcp add; VS Code: code --add-mcp). Placeholders in angle brackets are values you fill in. Codex takes hosted servers in config.toml ([mcp_servers.<name>] url = …) rather than on the command line.

A starting point — check the repository for exact arguments and setup. Restart your client after editing the config.

Category
Business & CRM
Version
1.0.3
Registry
active
Published
11/18/2026
Listed in:Official MCP registry ↗how this is checked

Is it safe? Is it maintained?

Serverdex check: Nov 22, 2026

Mostly fine: Field Service Business Platform by Doing Work is maintained, hosted endpoint answering without a key.

Maintained
Active
Last commit 3 days ago (Nov 18, 2026), 0 open issues.
Official registry
Active
Published as work.doingwork/shop in the official MCP registry, version 1.0.3.
Source
No licence found
Public repository, but GitHub reports no recognised licence (0 stars). Check the README before shipping it in a product.
Runs
Hosted by the publisher
Your client talks to doingwork.work: prompts and tool arguments leave your machine for that host.
Credentials
None needed to connect
The hosted endpoint completed the Serverdex initialize + tools/list handshake with no key (checked Nov 22, 2026); individual tools may still ask for one.
Owner
Unclaimed
Nobody has claimed this page yet; the data above comes from the registry, GitHub and the live check.

Facts only: last commit and licence from GitHub, the entry's status from the official registry, credentials from the live check. Not a code audit — run the security scan on the endpoint yourself and see the status history.

Live check

checked Nov 22, 2026, 10:07 UTCStatus history & uptime →
● Working150 msprotocol 2025-06-18v2026-11-01tools

The endpoint answered the MCP handshake as "doing-work" and listed 440 tools. Answering since Nov 19, 2026.

Context cost ≈ 180k tokens of tool definitions a client loads per conversation (estimate: characters ÷ 4) across 440 tools.

Tools (440)

  • auth_requestLink2 params

    Email a one-time sign-in link. Always answers ok, so it never reveals whether an email has an account.

    Show parameters
    • emailstringrequired
    • nextstring
  • auth_sendLink3 params

    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). The screen comes from a fixed list: today, prices, brand, payments, resume, terms, transfer, close, work, capture, subcontractors, claim, card, hub, board, override, start. Shop screens take shop_id; capture and subcontractors take job_id; claim is refused here, because the agent connect flow sends its own link; board takes shop_id and an optional date; override takes kind (job or visit) and id; card and hub take the key from their link. To send a page to a named member of your shop with role and assignment checks, use members.sendPage. The link works once, in any browser, and expires in 15 minutes. Always answers ok, so it never reveals whether an email has an account. The page still checks that the person may see it.

    Show parameters
    • emailstringrequired
    • screenstringrequired
    • paramsobjectValues the screen reads, such as shop_id or job_id.
  • auth_oauthRegister13 params

    Register an OAuth client (RFC 7591 dynamic registration). Public clients only: PKCE, no secret. Redirects must be https, or http on loopback.

    Show parameters
    • client_namestring
    • redirect_urisarrayrequired
    • token_endpoint_auth_methodstring
    • grant_typesarray
    • response_typesarray
    • client_uristring
    • logo_uristring
    • tos_uristring
    • policy_uristring
    • contactsarray
    • software_idstring
    • software_versionstring
    • scopestring
  • auth_oauthAuthorize9 params

    A signed-in person approves an agent client. Returns the redirect with a one-time code (PKCE S256). Needs a browser session, not an agent token. `resource` (RFC 8707) binds the token to this server's MCP endpoint.

    Show parameters
    • client_idstringrequired
    • redirect_uristringrequired
    • code_challengestringrequired
    • code_challenge_methodstringrequired
    • statestring
    • shop_idstring
    • resourcestring
    • scopestring
    • response_typestring
  • auth_oauthToken9 params

    Exchange an authorization code and PKCE verifier, or a refresh token, for a short-lived agent access token and a new refresh token. Refresh tokens rotate: each works once (with a 60-second retry window for simultaneous refreshes), and reusing one after that window revokes the whole chain. With grant_type urn:workos:agent-auth:grant-type:claim and your claim_token (auth.md), poll every interval only while the error is authorization_pending. slow_down means wait longer and poll again. access_denied, expired_token, and invalid_grant end this claim. Also stop when expires_in has passed. shown_once is only on success. Success hands over a named agent key once (no refresh token, it does not expire until revoked).

    Show parameters
    • grant_typestringrequired
    • codestring
    • code_verifierstring
    • client_idstring
    • redirect_uristring
    • refresh_tokenstring
    • resourcestring
    • claim_tokenstring
    • scopestring
  • me_get

    The signed-in person. Call me.start for shops, what this connection can do, and the next tasks.

  • me_start

    Start here. Shops this connection can use, the grant in plain words, counts, and the next tasks for the state of each shop.

  • me_shops2 params

    Shops the signed-in person belongs to right now, with their role. A shop key gets only the one shop that key is bound to.

    Show parameters
    • limitintegerHow many rows to return. Default 50 when you leave it out. An integer, or a numeric string such as "50".
    • cursorstring
  • shops_create7 params

    Create a shop. The caller becomes its one owner. The caller must already have accepted the current Terms and Privacy, once for their account, which covers every shop. Until then this call is refused and names /p/legal. On the sign-up page, one checkbox records both current versions (accept_terms_version) with the version, time, IP address and browser. A person who already accepted is not asked again. An agent cannot agree for them. owner_name, when it is a real name, replaces a display name that is only the email local part.

    Show parameters
    • namestringrequired
    • jurisdictionstringrequired
    • accept_terms_versionstringSign-up page only: the person agreed to the current Terms and Privacy Policy
    • owner_namestringThe person's name, when they typed one. Replaces a display name that is only the email local part.
    • partner_codestringOptional affiliate partner or referral code for this shop.
    • referral_codestringOptional alias for partner_code.
    • lead_codestringOptional internal acquisition or campaign tracking code for this shop.
  • members_invite3 params

    Invite a person by email as office, lead or field. Owners and office can invite. A lead cannot. The invite link works once. Shop roles are owner, office, lead and field.

    Show parameters
    • shop_idstringrequired
    • emailstringrequired
    • rolestringrequired
  • members_resendInvite1 param

    Email an open invite again with a new link, for a worker or office member who lost it or let it expire. The old invite is revoked and a new one is made with the same email and role: use the invite_id this returns from now on. The new link works once for 14 days. Owners and office only. Accepted or revoked invites are refused.

    Show parameters
    • invite_idstringrequired
  • members_sendPage4 params

    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). Owners and office only. The member is named by membership_id, so the link only goes to someone in the shop. The link works once and expires in 15 minutes. The page still checks access when it opens.

    Show parameters
    • shop_idstringrequired
    • membership_idstringrequired
    • screenstringrequired
    • paramsobjectboard: date (YYYY-MM-DD, optional). override: kind (job or visit) and id. capture: job_id.
  • members_accept1 param

    Accept an invite as the signed-in person. The invite email must match yours.

    Show parameters
    • tokenstringrequired
  • members_list2 params

    Current members of a shop with role and start date. Role is owner, office, lead or field.

    Show parameters
    • shop_idstringrequired
    • include_endedstring
  • members_end1 param

    End a membership: the owner removes a worker, or a worker leaves. Shop tokens end with it. The owner cannot leave; ownership moves only by transfer.

    Show parameters
    • membership_idstringrequired
  • members_changeRole2 params

    Owner changes a worker among office, lead and field. The old membership ends and a new one starts, so history keeps both. Shop roles are owner, office, lead and field.

    Show parameters
    • membership_idstringrequired
    • rolestringrequired
  • jobs_create4 params

    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"}.

    Show parameters
    • shop_idstringrequired
    • customer_idstring
    • summarystring
    • addressobjectrequiredaddress 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-I
  • jobs_list3 params

    Jobs of a shop you belong to, newest first. A field worker sees only jobs with a visit they are assigned to. A lead also sees jobs their crew is on. Another shop is refused, including a shop token pointed at a different shop. Optional status filter. Shop roles are owner, office, lead and field.

    Show parameters
    • shop_idstringrequired
    • statusstring
    • limitintegerHow many jobs to return (default 50). An integer, or a numeric string such as "50".
  • jobs_get1 param

    One job with its home address and, when it was converted from a request, that request. A field worker gets not found unless they are assigned to a visit on it. A lead also gets a job their crew is on. Notes on the job are notes_list and notes_add (target_kind job, target_id this job_id), not fields on this result.

    Show parameters
    • job_idstringrequired
  • media_requestUpload10 params

    Get a signed upload URL for a job photo or video. Before you call this, look at the file and say what it shows in summary: plain words, findings, any text you can read (model and serial plates), measurements, and for video a transcript, key moments and the length. If what you see does not match what the worker said, tell the worker before you upload. If you cannot look at it, send summary.unable_to_analyze with a reason and the media is listed by media.needsSummary. Summaries stay inside the shop and are searchable with media.list q and search.global. Photos: JPEG, PNG, WebP, HEIC or TIFF (HEIC and TIFF are kept as sent, with a JPEG copy for viewing). Video: MP4, MOV or WebM. Without object storage it is kept on this server, at most 100 MB and 10 minutes, and is not shared outside the shop. When R2 is configured, a video is uploaded in parts directly to storage (mode multipart, then media.videoPartUrls, media.completeVideoUpload or media.abortVideoUpload), up to 2 GB and 30 minutes unless DW_MAX_VIDEO_BYTES or DW_MAX_VIDEO_SECONDS set a different cap, and it can be included on a share link. The server does not download the video to recheck the hash. Declare the sha256 of the bytes you will send as exactly 64 hex characters (upper or lower case). Anything else is refused and no upload link is made. The upload is rejected if the bytes differ. Taken time, GPS location, heading and camera details are read from photos and kept for your shop. Copies shared outside the shop (share links, quote pages, PDFs) have that metadata removed. Pass provided_by customer when the customer sent the file, and channel for how it arrived (upload, email, text, capture, network_request, import). customer_id is optional and must be a customer of this shop.

    Show parameters
    • job_idstringrequired
    • stagestringrequired
    • sha256stringrequiredSHA-256 of the bytes you will upload, exactly 64 hex characters.
    • shows_interiorboolean
    • kindstringDefault photo
    • summaryobjectrequiredWhat you saw in the file. Look at the photo or watch the video before you upload it. Send either summary (with generated_by) or unable_to_analyze, never both.
    • content_typestringVideo only, when it uploads in parts. Default mp4.
    • provided_bystringDefault shop. customer when the customer sent the file.
    • channelstringHow the file arrived. Default upload.
    • customer_idstring
  • media_requestCustomerUpload3 params

    Make an expiring link the customer opens with no account and uses to send photos or videos for one job. The link lasts days (1 to 14, default 7). Each file is saved as provided_by customer and channel upload, with the same size limits, type checks, and location handling as a shop upload: the shop keeps camera details, and copies that leave the shop have them removed. Pass customer_id to name the customer, or leave it out to use the job's customer.

    Show parameters
    • job_idstringrequired
    • customer_idstring
    • daysinteger
  • media_videoPartUrls2 params

    Presigned URLs for the parts of a video upload that media.requestUpload started in multipart mode. Each URL accepts one PUT of part_size bytes (the last part may be shorter) and expires in 20 minutes. Ask again for the next parts. The server never sees the bytes.

    Show parameters
    • upload_tokenstringrequired
    • part_numbersarrayrequired
  • media_completeVideoUpload2 params

    Finish a part upload after every part has been sent. Send each part number and the ETag the storage returned. The server checks the size and the first bytes, then saves the video on the job. It does not download the video.

    Show parameters
    • upload_tokenstringrequired
    • partsarrayrequired
  • media_abortVideoUpload1 param

    Stop a part upload and drop the parts already sent. The video is not saved.

    Show parameters
    • upload_tokenstringrequired
  • media_list13 params

    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. Filter by job, kind, words in the summary or transcript (q), summary status, distance from a point, taken time, or whether it has a location.

    Show parameters
    • job_idstringOnly photos on this job. Leave out to search every photo you can see.
    • shop_idstring
    • near_latnumberLatitude of a point; with near_lng and radius_m, only photos taken within radius_m of it
    • near_lngnumber
    • radius_mnumberSearch radius in meters (default 200, max 50000)
    • taken_afterstringISO date or time: photos taken at or after this
    • taken_beforestringISO date or time: photos taken before this
    • has_locationstringOnly photos with (true) or without (false) GPS
    • sortstringDefault uploaded; distance needs near_lat and near_lng
    • limitinteger
    • kindstringOnly photos or only videos
    • qstringWords to find in what agents said the photo or video shows: summary, readable text such as serial numbers, findings and video transcripts
    • summary_statusstring
  • media_map13 params

    Photos with a GPS location as a GeoJSON FeatureCollection (points in longitude, latitude order), ready for a map. Takes the same filters as media.list.

    Show parameters
    • job_idstringOnly photos on this job. Leave out to search every photo you can see.
    • shop_idstring
    • near_latnumberLatitude of a point; with near_lng and radius_m, only photos taken within radius_m of it
    • near_lngnumber
    • radius_mnumberSearch radius in meters (default 200, max 50000)
    • taken_afterstringISO date or time: photos taken at or after this
    • taken_beforestringISO date or time: photos taken before this
    • has_locationstringOnly photos with (true) or without (false) GPS
    • sortstringDefault uploaded; distance needs near_lat and near_lng
    • limitinteger
    • kindstringOnly photos or only videos
    • qstringWords to find in what agents said the photo or video shows: summary, readable text such as serial numbers, findings and video transcripts
    • summary_statusstring
  • media_get3 params

    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. Set include_content to get the stored bytes as base64 (metadata included), or include_original to get the original HEIC or TIFF when the photo was converted.

    Show parameters
    • media_idstringrequired
    • include_contentstring
    • include_originalstring
  • jobs_requestConfirmation1 param

    Get a single-use link the customer opens to confirm the work was done (or flag a problem).

    Show parameters
    • job_idstringrequired
  • media_setSummary3 params

    Write or correct what a photo or video shows. Use it to fix a summary, to fill in one marked needs_summary (older photos and browser captures have none), or after a person edits the words. Each change keeps the earlier wording. Workers on the shop can edit; the summary is never shown to customers.

    Show parameters
    • media_idstringrequired
    • summaryobjectrequiredWhat you saw in the file. Look at the photo or watch the video before you upload it. Send either summary (with generated_by) or unable_to_analyze, never both.
    • edited_by_personbooleanTrue when a person wrote or changed these words, not your model
  • media_needsSummary4 params

    Photos and videos with no summary yet: older uploads, browser captures, and uploads whose agent could not look at the file. Open each with media.get include_content, look at it, then send media.setSummary.

    Show parameters
    • shop_idstringrequired
    • job_idstring
    • kindstring
    • limitinteger
  • quotes_create6 params

    Create a quote (AI can draft lines; a person who can send quotes approves agent-drafted lines before the quote is sent). Optional: good, better, best options and optional lines the customer picks when signing.

    Show parameters
    • job_idstringrequired
    • linesarrayrequired
    • optionsarrayGood, better, best: 2 to 5 options the customer chooses one of when signing. Each needs its own lines.
    • tmobjectRush or open-ended work: the customer signs the rates, and invoices.createFromTm bills approved time and materials at them. Lines may then be empty.
    • notesstring | nullWritten scope of work stored on this version. The customer page and PDF show it.
    • tax_rate_idstring | nullTax rate to charge (taxes.listRates). Leave out to use the shop default rate; null for no tax.
  • quotes_send2 params

    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). Who may send is shops.sendPermissions: the owner always may, office for any job, a lead for jobs on their crew, and a field worker for jobs assigned to them, until the owner turns that off. Lines an agent drafted are refused until a person who may send quotes sends the quote. An agent token cannot send those lines. A quote imported as history cannot be sent.

    Show parameters
    • quote_idstringrequired
    • email_customerbooleanAlso email the customer a branded email with their own signing link, from the shop. Default false: you share sign_url yourself.
  • quotes_revise5 params

    Pass the COMPLETE new line list; any line you omit is removed. Replace an unsigned quote with a new version. Earlier signing links stop working; send it again for a new link.

    Show parameters
    • quote_idstringrequired
    • linesarrayrequired
    • optionsarrayGood, better, best: 2 to 5 options the customer chooses one of when signing. Each needs its own lines.
    • tmobject | nullNew rates. Leave out to keep the rates of the last version; null to make it a fixed price quote.
    • tax_rate_idstring | nullTax rate to charge (taxes.listRates). Leave out to use the shop default rate; null for no tax.
  • quotes_withdraw2 params

    Withdraw a draft or sent quote the customer has not signed, with an optional reason. Signing links stop working and follow-ups stop. A withdrawn quote cannot be reopened; create a new quote if needed.

    Show parameters
    • quote_idstringrequired
    • reasonstringWhy it was withdrawn, up to 500 characters. Kept with the quote, not shown to the customer.
  • quotes_get1 param

    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. Read only. This is a quote, not an AI line draft (that is quotes.draft).

    Show parameters
    • quote_idstringrequired
  • quotes_list5 params

    Customer quotes in one shop, newest first. Filter by job_id, status, or both. Read only. Send shop_id or job_id. A shop you are not a member of is refused, and a job you cannot access is not found.

    Show parameters
    • shop_idstring
    • job_idstring
    • statusstring
    • limitintegerHow many rows to return. Default 50 when you leave it out. An integer, or a numeric string such as "50".
    • cursorstring
  • subcontractors_get1 param

    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.

    Show parameters
    • job_idstringrequired
  • subcontractors_prepare3 params

    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". Does not sign.

    Show parameters
    • job_idstringrequired
    • entriesarraySubcontractors, materialmen and rental equipment providers over $500.
    • none_attestationstring
  • payments_connectLink1 param

    Owner only: the link to the shop's payment setup page. Give it to the owner; they open it, sign in, and press one button to set up card and bank payments with Stripe. Nothing starts until they do. status is none, onboarding, active, restricted or settling_only.

    Show parameters
    • shop_idstringrequired
  • invoices_createFromQuote2 params

    Create an invoice for a signed quote, for the total of the option and optional lines the customer picked. A quote imported as history cannot be invoiced.

    Show parameters
    • quote_idstringrequired
    • deposit_minorintegerOptional deposit asked for on the first send
  • invoices_send4 params

    Send an invoice (or the next part of it) and get a single-use pay link. Who may send is shops.sendPermissions: the owner always may, office for any job, a lead for jobs on their crew, and a field worker for jobs assigned to them, until the owner turns that off. Lines an agent drafted stay unsent until a person who may send invoices sends them. An agent token cannot send those lines. Earlier pay links stop working. Refused with conflict on a Doing Work deposit invoice whose booking ended (shop cancel or no-show). payments_ready false means the shop has no active payments account yet (after a hand-off, connect one with payments.connectLink); the link shows payment isn't available until it does.

    Show parameters
    • invoice_idstringrequired
    • amount_minorintegerAmount to ask for now. Defaults to the deposit on the first send, then the balance.
    • percentnumberProgress billing: ask for this percent of the invoice total now (capped at the balance). Use instead of amount_minor.
    • email_customerbooleanAlso email the customer a branded email with their own pay link, from the shop. Default false: you share pay_url yourself.
  • invoices_markPaidOutside4 params

    Record that the customer paid an invoice outside Doing Work (check, cash, financing, insurance or other). Owner or office, or their agent. Closes the invoice, and the job too unless its checklists still block done (job_status says which; finish them and call jobs.complete). The job record says "Paid outside Doing Work", is never marked paid or verified, and no Doing Work receipt goes to the customer. There is no limit on jobs paid outside Doing Work and no fee on them. Agents can record these too unless the owner turned that off with shops.setAgentMoney.

    Show parameters
    • invoice_idstringrequired
    • methodstringrequired
    • paid_onstringrequiredDate the customer paid, YYYY-MM-DD
    • notestringOptional note for the shop, up to 500 characters. Not shown in the home record.
  • invoices_refund2 params

    Refund part or all of a payment (owner or office, or their agent). The reply says requested. Confirmation arrives shortly, and invoices.get is where the confirmed refund shows. An agent refund above the shop's agent refund cap (shops.setAgentMoney, $250 unless the owner changed it) does not run: it waits for the owner's OK and the reply says approval_required.

    Show parameters
    • charge_idstringrequired
    • amount_minorintegerrequired
  • 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. No subscription. The fee comes out of the payment.

  • fees_preview2 params

    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). Leave out amount_minor for just the month picture. The checkout may ask Stripe to hold more, then return the difference when the payment succeeds.

    Show parameters
    • shop_idstringrequired
    • amount_minorintegerA payment amount in cents
  • fees_statement2 params

    A month's Doing Work fees for a shop: payments, fees by kind, the effective rate, and each line (owner or office). volume_minor is the owner's month total the fee was based on, the same number fees.preview returns as month_volume_minor for this month. Refunds do not lower that total.

    Show parameters
    • shop_idstringrequired
    • monthstringrequired
  • records_keys

    Public keys that verify signed job records.

  • jobs_record1 param

    The latest signed record for a job and its level (logged, paid, verified). When the job has none yet, record is null and reason says so.

    Show parameters
    • job_idstringrequired
  • webhooks_create3 params

    Add a webhook endpoint for a shop (owner or office, or their agent). The url must be https on a public internet address. Returns the signing secret once; it is never shown again.

    Show parameters
    • shop_idstringrequired
    • urlstringrequired
    • eventsarray
  • webhooks_list1 param

    List a shop's webhook endpoints and their recent delivery counts. Secrets are not returned.

    Show parameters
    • shop_idstringrequired
  • webhooks_delete1 param

    Remove a webhook endpoint. Pending deliveries to it stop.

    Show parameters
    • endpoint_idstringrequired
  • audit_list3 params

    Read a shop's audit log, newest first (owner only).

    Show parameters
    • shop_idstringrequired
    • limitinteger
    • before_idinteger
  • platforms_create2 params

    Create a developer platform account (private beta). The caller owns it.

    Show parameters
    • namestringrequired
    • terms_versionstringrequired
  • 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.

  • platforms_revokeManage1 param

    Stop a platform from managing this shop. Shop owner only.

    Show parameters
    • grant_idstringrequired
  • customers_create10 params

    Add a customer to a shop, with kind, company, email, phone, billing address, lead source, tags and notes in one call.

    Show parameters
    • shop_idstringrequired
    • namestringrequired
    • kindstring
    • company_namestring
    • emailstring
    • phonestring
    • billing_addressobject
    • lead_sourcestring
    • tagsarray
    • notesstring
  • customers_get1 param

    One customer with contacts, properties, custom fields and open balance. A field worker gets not found unless the customer has a job they are assigned to. open_balance_minor is null when see_prices is off.

    Show parameters
    • customer_idstringrequired
  • customers_list6 params

    Customers of a shop, newest first, filtered by tag, lead source or archived. A field worker sees only customers on a job they are assigned to.

    Show parameters
    • shop_idstringrequired
    • tagstring
    • lead_sourcestring
    • archivedboolean
    • limitintegerHow many rows to return. Default 50 when you leave it out. An integer, or a numeric string such as "50".
    • cursorstring
  • customers_search4 params

    Find customers by name, company, email, phone or property address.

    Show parameters
    • shop_idstringrequired
    • qstringrequired
    • include_archivedboolean
    • limitintegerHow many rows to return. Default 50 when you leave it out. An integer, or a numeric string such as "50".
  • customers_update10 params

    Change a customer's name, kind, company, email, phone, billing address, lead source, tags or notes.

    Show parameters
    • customer_idstringrequired
    • namestring
    • kindstring
    • company_namestring
    • emailstring
    • phonestring
    • billing_addressobject
    • lead_sourcestring
    • tagsarray
    • notesstring
  • customers_archive2 params

    Archive a customer (hidden from lists, history kept) or bring one back.

    Show parameters
    • customer_idstringrequired
    • archivedboolean
  • customers_duplicates2 params

    Likely duplicate customers in a shop: same email, same phone digits, or same name.

    Show parameters
    • shop_idstringrequired
    • customer_idstring
  • customers_merge2 params

    Merge a duplicate customer into another: jobs, requests, contacts, properties and fields move over.

    Show parameters
    • from_customer_idstringrequired
    • into_customer_idstringrequired
  • customers_contactAdd6 params

    Add a contact person to a customer (tenant, manager, billing, spouse).

    Show parameters
    • customer_idstringrequired
    • namestringrequired
    • emailstring
    • phonestring
    • rolestring
    • is_primaryboolean
  • customers_contactUpdate7 params

    Change or remove one contact of a customer.

    Show parameters
    • contact_idstringrequired
    • namestring
    • emailstring
    • phonestring
    • rolestring
    • is_primaryboolean
    • removedboolean
  • properties_add4 params

    Add a service address to a customer, with optional label and access notes.

    Show parameters
    • customer_idstringrequired
    • addressobjectrequiredaddress 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-I
    • labelstring
    • access_notesstring
  • properties_list5 params

    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.

    Show parameters
    • shop_idstring
    • customer_idstring
    • include_archivedboolean
    • limitintegerHow many rows to return. Default 50 when you leave it out. An integer, or a numeric string such as "50".
    • cursorstring
  • properties_update4 params

    Change a property's label or access notes, or archive it.

    Show parameters
    • property_idstringrequired
    • labelstring
    • access_notesstring
    • archivedboolean
  • equipment_add8 params

    Record equipment at a property: kind, make, model, serial, install date and warranty.

    Show parameters
    • property_idstringrequired
    • kindstringrequired
    • makestring
    • modelstring
    • serialstring
    • install_datestring
    • warranty_untilstring
    • notesstring
  • equipment_list4 params

    Equipment at a property, or warranties ending soon across a shop.

    Show parameters
    • property_idstring
    • shop_idstring
    • warranty_ends_within_daysinteger
    • include_archivedboolean
  • equipment_update9 params

    Change or archive an equipment record.

    Show parameters
    • equipment_idstringrequired
    • kindstring
    • makestring
    • modelstring
    • serialstring
    • install_datestring
    • warranty_untilstring
    • notesstring
    • archivedboolean
  • jobs_setTags3 params

    Set the tags and lead source on a job.

    Show parameters
    • job_idstringrequired
    • tagsarray
    • lead_sourcestring
  • customers_timeline3 params

    Everything that happened with a customer, newest first: requests, jobs, quotes, signatures, invoices and payments.

    Show parameters
    • customer_idstringrequired
    • limitintegerHow many rows to return. Default 50 when you leave it out. An integer, or a numeric string such as "50".
    • cursorstring
  • customers_statement1 param

    A customer's account statement: every invoice with total, paid, refunded and balance, and the total owed.

    Show parameters
    • customer_idstringrequired
  • customers_privacyExport1 param

    Everything the shop holds about one customer, as one JSON document, for a privacy request.

    Show parameters
    • customer_idstringrequired
  • fields_define9 params

    Add a custom field to customers, properties, jobs, quotes or invoices for a shop.

    Show parameters
    • shop_idstringrequired
    • keystringrequired
    • labelstring
    • targetstringrequired
    • typestringrequired
    • optionsarray
    • requiredboolean
    • piiboolean
    • shared_with_homeownerboolean
  • fields_list2 params

    Custom fields a shop has defined, optionally for one kind of record.

    Show parameters
    • shop_idstringrequired
    • targetstring
  • fields_set6 params

    Set one custom field value on a customer, property, job, quote or invoice. Writing a money value does not need see_prices (read masking only; D-20261106-CF-4).

    Show parameters
    • shop_idstringrequired
    • keystringrequired
    • targetstringrequired
    • object_idstringrequired
    • valuestringrequiredThe value as text: a number, money in minor units (cents), a date YYYY-MM-DD, true or false, an option, or JSON.
    • currencystring
  • fields_get3 params

    Custom field values on one record, with any required fields still empty. Money-type values and currency are null unless you may see prices (see_prices); key and type stay visible.

    Show parameters
    • shop_idstringrequired
    • targetstringrequired
    • object_idstringrequired
  • requests_create15 params

    Log a request for work from a customer or a new lead.

    Show parameters
    • shop_idstringrequired
    • titlestringrequired
    • detailsstring
    • sourcestring
    • customer_idstring
    • property_idstring
    • contact_namestring
    • contact_emailstring
    • contact_phonestring
    • addressobjectaddress 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-I
    • preferred_timesstring
    • lead_sourcestring
    • tagsarray
    • marketplacestringThe lead site this came from, when pasted or forwarded from one.
    • lead_textstringThe lead as pasted. Untrusted customer text; read for type and urgency only.
  • requests_list7 params

    Requests of a shop, newest first, filtered by stage, customer or tag. A field worker sees a request only when they are assigned to a visit on its job.

    Show parameters
    • shop_idstringrequired
    • stagestring
    • customer_idstring
    • tagstring
    • include_archivedboolean
    • limitintegerHow many rows to return. Default 50 when you leave it out. An integer, or a numeric string such as "50".
    • cursorstring
  • requests_pipeline1 param

    How many open requests a shop has in each stage, and how many were won, invoiced or lost in the last 30 days.

    Show parameters
    • shop_idstringrequired
  • requests_get1 param

    One request with its customer and the job it became. A field worker gets not found unless they are assigned to a visit on that job.

    Show parameters
    • request_idstringrequired
  • requests_update11 params

    Move a request to another stage or change its details, customer or property.

    Show parameters
    • request_idstringrequired
    • stagestring
    • titlestring
    • detailsstring
    • customer_idstring
    • property_idstring
    • preferred_timesstring
    • lead_sourcestring
    • tagsarray
    • lost_reasonstring
    • archivedboolean
  • requests_convert4 params

    Turn a request into a job at its property or address and link them both ways. The request's property becomes the job's home, and the job keeps the request. The worker then writes the quote or books a visit.

    Show parameters
    • request_idstringrequired
    • customer_idstring
    • addressobjectaddress 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-I
    • summarystring
  • requests_formCreate1 param

    Turn on the shop's public request form and get its key. Making a new one turns off the old key.

    Show parameters
    • shop_idstringrequired
  • requests_submitForm9 params

    Send a shop a request through its public form. No sign-in; needs the form key.

    Show parameters
    • form_keystringrequired
    • titlestringrequired
    • detailsstring
    • namestringrequired
    • emailstring
    • phonestring
    • addressobjectaddress 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-I
    • preferred_timesstring
    • sms_opt_inbooleanThe customer checked the box to get texts about this request. Needs phone. Saved as pending until they text YES.
  • visits_createRecurring11 params

    Book a repeating visit (daily, weekly or monthly, every n) for a job. All visits are booked now, up to 104. Times repeat in the shop's local time zone. Overlaps and unavailable workers come back as warnings, never blocks.

    Show parameters
    • job_idstringrequired
    • starts_atstringrequired
    • ends_atstringrequired
    • freqstringrequired
    • everyinteger
    • occurrencesinteger
    • untilstring
    • titlestring
    • notesstring
    • assignee_idsarray
    • arrival_window_minutesintegerArrival window in minutes: the customer is told the worker arrives between starts_at and starts_at plus this. Defaults to the shop's setting (schedule.setRules)
  • visits_cancelSeries3 params

    Cancel the visits of a repeating series that have not started yet, from a time onward (default now). Past, started and done visits stay.

    Show parameters
    • series_idstringrequired
    • fromstring
    • reasonstring
  • visits_start1 param

    Mark a visit started (from scheduled, on the way, or arrived). The worker on the visit (or the office) can do this.

    Show parameters
    • visit_idstringrequired
  • visits_done3 params

    Mark a visit done, with an optional note. The worker on the visit (or the office) can do this. A visit not yet started is started too. Refused with checklist_open while a checklist on the visit has required items open or a sign-off missing; the owner, signed in on the hosted override page (/p/checklist/override), may pass override_reason to mark it done anyway (recorded and audited). Agents, keys and office staff cannot override.

    Show parameters
    • visit_idstringrequired
    • notestring
    • override_reasonstringOwner in person only (hosted override page): why the visit is done with checklist work left.
  • visits_create9 params

    Book a visit to a job at a time, optionally with the workers going (assignee_ids, a saved crew_id, or both). Overlaps for those workers come back in conflicts.

    Show parameters
    • job_idstringrequired
    • starts_atstringrequired
    • ends_atstringrequired
    • titlestring
    • notesstring
    • assignee_idsarray
    • crew_idstring
    • arrival_window_minutesintegerArrival window in minutes: the customer is told the worker arrives between starts_at and starts_at plus this. Defaults to the shop's setting (schedule.setRules)
    • prioritystringnormal (default), urgent or emergency. Urgent and emergency visits send visit.priority_set and can use dispatch.suggest.
  • visits_update6 params

    Move a visit or change its title, notes or arrival window. Overlaps for its workers come back in conflicts. Moving it re-plans the appointment reminder.

    Show parameters
    • visit_idstringrequired
    • starts_atstring
    • ends_atstring
    • titlestring
    • notesstring
    • arrival_window_minutesintegerArrival window in minutes: the customer is told the worker arrives between starts_at and starts_at plus this. Defaults to the shop's setting (schedule.setRules)
  • visits_assign3 params

    Set who is going on a visit: person_ids, a saved crew_id, or both. The list replaces the current one; an empty person_ids with no crew leaves it unassigned.

    Show parameters
    • visit_idstringrequired
    • person_idsarray
    • crew_idstring
  • visits_cancel2 params

    Cancel a visit that is scheduled, on the way, or arrived. It stays on record with the reason, and customer notices not yet sent for it are dropped.

    Show parameters
    • visit_idstringrequired
    • reasonstring
  • visits_setPriority3 params

    Set a visit's priority: normal, urgent or emergency. Sends visit.priority_set. For urgent or emergency, call dispatch.suggest for who could go.

    Show parameters
    • visit_idstringrequired
    • prioritystringrequirednormal (default), urgent or emergency. Urgent and emergency visits send visit.priority_set and can use dispatch.suggest.
    • reasonstring
  • dispatch_suggest2 params

    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. Suggestions only; assign with visits.assign.

    Show parameters
    • visit_idstringrequired
    • limitinteger
  • visits_get1 param

    One visit with its job and workers.

    Show parameters
    • visit_idstringrequired
  • schedule_list8 params

    A shop's visits that overlap a time window, earliest first. Filter by worker, job, or only mine. Field workers only ever see their own. A lead sees the crews they belong to or lead. Shop roles are owner, office, lead and field.

    Show parameters
    • shop_idstringrequired
    • fromstringrequired
    • tostringrequired
    • person_idstring
    • job_idstring
    • mineboolean
    • unassignedboolean
    • include_cancelledboolean
  • routes_setLocation5 params

    Save the map point for a job's address, so routes.day can give it to you with each stop (owner or office). Look the address up with your own maps tools, or have a person type it in. Doing Work does not look addresses up. The point is kept for this shop's jobs at the same address.

    Show parameters
    • job_idstring
    • visit_idstring
    • latnumberrequiredLatitude in decimal degrees (WGS 84), for example 43.6150.
    • lngnumberrequiredLongitude in decimal degrees (WGS 84), for example -116.2023.
    • sourcestringagent when your tools looked it up (default), typed when a person typed it in.
  • routes_setStart6 params

    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. Owner or office for anyone; a worker for themselves. A worker's own start is seen only by them and the owner or office.

    Show parameters
    • shop_idstringrequired
    • person_idstring
    • labelstringrequiredA short name, for example "Shop yard" or "Home".
    • latnumberrequiredLatitude in decimal degrees (WGS 84), for example 43.6150.
    • lngnumberrequiredLongitude in decimal degrees (WGS 84), for example -116.2023.
    • sourcestringagent when your tools looked it up (default), typed when a person typed it in.
  • routes_day3 params

    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. Visits with no worker come back in unassigned. Owner and office see everyone; a lead sees their crew's day; a field worker sees only their own day. Plan the order with your own tools, then write it back with routes.apply.

    Show parameters
    • shop_idstringrequired
    • datestringrequiredThe day in the shop's time zone, YYYY-MM-DD.
    • person_idsarrayOnly these workers. Default: everyone with a stop that day.
  • routes_apply4 params

    Write a planned route back: new times, and optionally new workers, for up to 100 visits at once (owner or office). All or nothing: if any visit is not scheduled (already on the way, there, started, done or cancelled), not this shop's, or the plan leaves a worker with overlapping visits, nothing changes and the problems come back in conflicts. Pass allow_overlaps true to save overlaps anyway, or dry_run true to check without saving. Each moved visit gets its appointment reminder planned again once.

    Show parameters
    • shop_idstringrequired
    • changesarrayrequired
    • allow_overlapsboolean
    • dry_runboolean
  • vendors_create6 params

    Add a supplier the shop buys parts from. Owner or office.

    Show parameters
    • shop_idstringrequired
    • namestringrequired
    • emailstring
    • phonestring
    • account_numberstring
    • notestring
  • vendors_update7 params

    Change a supplier's name, contact details or note, or archive it (archived: true). Owner or office.

    Show parameters
    • vendor_idstringrequired
    • namestring
    • emailstring
    • phonestring
    • account_numberstring
    • notestring
    • archivedboolean
  • vendors_list2 params

    List the shop's suppliers (archived ones only with include_archived). Owner or office.

    Show parameters
    • shop_idstringrequired
    • include_archivedboolean
  • po_create4 params

    Start a purchase order (draft) for parts for a job from a supplier. Nothing counts as job cost until po.receive. Owner or office.

    Show parameters
    • job_idstringrequired
    • vendor_idstringrequired
    • notestring
    • linesarrayrequired
  • po_update4 params

    Change a draft purchase order's supplier, note or lines (lines replace all lines). Owner or office.

    Show parameters
    • po_idstringrequired
    • vendor_idstring
    • notestring
    • linesarray
  • po_get1 param

    A purchase order with its lines, what was received (in job cost) and the supplier's bill. Owner or office.

    Show parameters
    • po_idstringrequired
  • po_list4 params

    List purchase orders for the shop, or for one job or supplier, newest first. Owner or office.

    Show parameters
    • shop_idstringrequired
    • job_idstring
    • vendor_idstring
    • limitinteger
  • po_markOrdered1 param

    Mark a draft purchase order as sent to the supplier (the agent or a person sends it). Owner or office.

    Show parameters
    • po_idstringrequired
  • po_receive3 params

    Record parts that arrived. Each received line becomes a material on the job at the line's cost (this is the only way a purchase order reaches job cost; do not also add an expense for it). Leave lines out to receive everything left. Owner or office.

    Show parameters
    • po_idstringrequired
    • visit_idstring
    • linesarray
  • po_undoReceipt2 params

    Take back a received material from a purchase order (wrong part, returned). It leaves job cost and the line can be received again. Owner or office.

    Show parameters
    • material_idstringrequired
    • reasonstring
  • po_cancel1 param

    Cancel a purchase order that has nothing received (undo receipts first). Owner or office.

    Show parameters
    • po_idstringrequired
  • po_recordBill3 params

    Record the supplier's bill for a purchase order, for paying the supplier. It is never added to job cost or expenses (the received materials already are); the difference from what was received is shown. Owner or office.

    Show parameters
    • po_idstringrequired
    • bill_minorintegerrequired
    • bill_refstring
  • calendar_createFeed2 params

    Make a calendar feed link (.ics) of one worker's visits that a calendar app subscribes to (read only). Leave person_id out for your own; owner or office can make one for any current member. A new feed turns that person's old one off. The link is shown once.

    Show parameters
    • shop_idstringrequired
    • person_idstring
  • calendar_listFeeds2 params

    Calendar feeds in a shop, newest first, with whether each is active and how often it was fetched. Field workers see only their own. The link is not shown again.

    Show parameters
    • shop_idstringrequired
    • person_idstring
  • calendar_revokeFeed1 param

    Turn a calendar feed off now. Calendar apps that fetch it after this get 410 and stop showing new visits.

    Show parameters
    • feed_idstringrequired
  • availability_setHours3 params

    Set a worker's weekly hours, replacing what was there. Days are 0 (Sunday) to 6, times are shop local HH:MM. An empty list means no set hours (always available).

    Show parameters
    • shop_idstringrequired
    • person_idstring
    • hoursarrayrequired
  • availability_addTimeOff5 params

    Add time off for a worker (vacation, sick, appointment).

    Show parameters
    • shop_idstringrequired
    • person_idstring
    • starts_atstringrequired
    • ends_atstringrequired
    • reasonstring
  • availability_removeTimeOff1 param

    Remove a time-off entry.

    Show parameters
    • time_off_idstringrequired
  • availability_get4 params

    A worker's weekly hours, time off, and booked visits in a window (at most 62 days). Defaults to me.

    Show parameters
    • shop_idstringrequired
    • person_idstring
    • fromstringrequired
    • tostringrequired
  • schedule_settings1 param

    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. on_my_way_notices covers both the on the way and the arrived notice. arrival_notices is off unless the shop turns it on. When on, an on the way message includes an arrival time when one is known (a stored route estimate, or the time the worker entered; no drive time is looked up). On the way and arrived each go by text and by email. Any worker in the shop can read it.

    Show parameters
    • shop_idstringrequired
  • schedule_setShopHours2 params

    Set the shop's booking hours, replacing what was there (owner or office). Days are 0 (Sunday) to 6, times are shop local HH:MM, several blocks a day are fine. An empty list clears them, and find-a-time falls back to Monday to Friday 08:00 to 17:00. Visits outside these hours are still allowed and come back with outside_shop_hours.

    Show parameters
    • shop_idstringrequired
    • hoursarrayrequired
  • schedule_setRules7 params

    Change the shop's scheduling rules (owner or office; the time zone is owner only). arrival_window_minutes is the default window customers are told for new visits (0 means an exact time). buffer_minutes is travel and setup time find-a-time keeps clear around booked visits. reminder_hours is how long before a visit the customer gets an appointment reminder (0 turns reminders off). on_my_way_notices tells the customer by text and by email when a worker says they are on the way. Text is the main one. The email goes whenever the customer has an email address, even if the text does not. arrival_notices (off by default) adds an arrival time to that message when one is known (a stored route estimate, or the time the worker entered; route data has no drive time, so with no worker time there is no arrival line). The arrived text and email follow on_my_way_notices, the same setting as the on the way message. A do-not-email address is not emailed. Only the fields you send change. Visits already booked keep their window and reminder.

    Show parameters
    • shop_idstringrequired
    • arrival_window_minutesinteger
    • buffer_minutesinteger
    • reminder_hoursinteger
    • on_my_way_noticesboolean
    • arrival_noticesbooleanWhen true, an on the way message includes an arrival time when one is known (a stored route estimate, or the time the worker entered). Off by default. The arriv
    • time_zonestringIANA zone name, for example America/Boise.
  • schedule_findTime9 params

    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). Looks inside shop hours (or Monday to Friday 08:00 to 17:00 when none are set), skips worker time off and times outside a worker's own hours, and keeps the shop's travel buffer clear around booked visits. Give person_ids or a saved crew_id (or both) to check those workers (together: all of them free at once, the default; or any one of them). Leave it out to check every worker in the shop and get back who is free. A lead can check the crews they belong to or lead. Field workers can only check themselves. Nothing is booked; call visits.create with a slot.

    Show parameters
    • shop_idstringrequired
    • duration_minutesintegerrequired
    • fromstringEarliest start. Default now.
    • tostringLatest end. Default 14 days after from; at most 31 days after it.
    • person_idsarray
    • crew_idstring
    • togetherboolean
    • step_minutesintegerSpacing between candidate starts. Default 30.
    • limitintegerDefault 10.
  • visits_onTheWay3 params

    Mark that the worker is on the way to a visit, with an optional ETA (eta_at, or eta_minutes from now). The worker on the visit (or the office) can do this. When the shop has on the way notices on, the customer gets a text and an email. Text is the main one. The email goes whenever the customer has an email address, even if the text is blocked, refused, or does not go through. When arrival notices are also on, the message includes an arrival time: a route estimate when the visit already has one, otherwise the time the worker entered, otherwise no arrival line. Route data stores the booked start and the arrival window, not a drive time. Doing Work does not look up a drive time.

    Show parameters
    • visit_idstringrequired
    • eta_atstring
    • eta_minutesinteger
  • visits_arrived1 param

    Mark that the worker arrived at a visit. The worker on the visit (or the office) can do this. Any on the way message not yet sent is dropped. When on the way notices are on, the customer gets one arrived text and one arrived email. Text is the main one. The email goes whenever the customer has an email address, even if the text does not. A do-not-email address is not emailed. Once only.

    Show parameters
    • visit_idstringrequired
  • visit_on_my_way2 params

    Mark that the worker is on the way to a visit when they tell their agent, for example on my way, there by 2. eta is that time in their words and can be left out. A worker may call this only for a visit they are assigned to. The owner or office may call it for any visit in the shop. When on the way notices are on, the customer gets a text and an email. Text is the main one. The email goes whenever the customer has an email address, even if the text is blocked, refused, or does not go through. When arrival notices are also on, the message includes the time the worker gave. A repeat call does not send again.

    Show parameters
    • visit_idstringrequired
    • etastringA time the worker says, for example there by 2, 2:30 PM, or 20 minutes. Leave it out when they do not give a time.
  • visit_arrived1 param

    Mark that the worker has arrived at a visit when they tell their agent, for example I am here. A worker may call this only for a visit they are assigned to. The owner or office may call it for any visit in the shop. When on the way notices are on, the customer gets one arrived text and one arrived email. Text is the main one. The email goes whenever the customer has an email address, even if the text does not. A do-not-email address is not emailed. When on the way notices are off, this sends nothing. A repeat call does not send again.

    Show parameters
    • visit_idstringrequired
  • visits_notices1 param

    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. Owner or office.

    Show parameters
    • visit_idstringrequired
  • schedule_openSlots1 param

    Times the shop marked open for its voice agent to book (upcoming only), and which are booked. Any worker in the shop can read it.

    Show parameters
    • shop_idstringrequired
  • schedule_addOpenSlots2 params

    Mark times open for the shop's voice agent to book callers into (owner or office). The agent books them only when phone.setVoiceAi has book_open_slots true, which is off by default. Each slot is at most 12 hours and in the future. A booked slot becomes a request with that time for the office.

    Show parameters
    • shop_idstringrequired
    • slotsarrayrequired
  • schedule_removeOpenSlot2 params

    Take back an open time that is not booked yet (owner or office).

    Show parameters
    • shop_idstringrequired
    • slot_idstringrequired
  • schedule_bookingPage1 param

    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). Owner or office.

    Show parameters
    • shop_idstringrequired
  • schedule_setBookingPage9 params

    Configure the shop's hosted public booking page (/p/book/<slug>) for Google Business Profile and Google Actions Center. Setting google_enabled true requires enabled true, slug, trade, service_zips, contact_phone, and mailing_address matching Google Business Profile (owner only to update contact_phone or mailing_address; owner or office for booking fields).

    Show parameters
    • shop_idstringrequired
    • enabledboolean
    • slugstring | null
    • show_open_timesboolean
    • google_enabledboolean
    • tradestring | null
    • service_zipsarray
    • contact_phonestring | null
    • mailing_addressstring | null
  • shops_setInvoiceReminders3 params

    Turn the automatic unpaid-invoice reminder on or off for the whole shop (owner only). When on, a customer gets one friendly email reminder a set number of days (default 1) after an invoice or deposit request is sent if it is still unpaid. Mail comes from a doingwork.work address on the shop's behalf, with replies going to the owner.

    Show parameters
    • shop_idstringrequired
    • enabledbooleanrequired
    • delay_daysintegerDays after a send before the reminder goes out. Default 1.
  • shops_setContact3 params

    Set the phone and email customers see when they open a canceled invoice or quote link (owner only). Leave a field out or send null to fall back to the owner's own email and phone.

    Show parameters
    • shop_idstringrequired
    • phonestring | nullUp to 40 characters.
    • emailstring | nullAn email address customers can write to.
  • shops_setFieldCosts2 params

    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). Off by default. A worker whose own see_costs is off still does not see costs.

    Show parameters
    • shop_idstringrequired
    • enabledbooleanrequired
  • shops_setHubLinkInEmails2 params

    Turn the customer hub link in quote and invoice emails on or off for the whole shop (owner only). On by default: each quote or invoice email the customer gets from Doing Work ends with a link to their hub, where they see their quotes, invoices and visits with you.

    Show parameters
    • shop_idstringrequired
    • enabledbooleanrequired
  • invoices_setReminder2 params

    Turn the automatic unpaid reminder on or off for one invoice (owner or office).

    Show parameters
    • invoice_idstringrequired
    • enabledbooleanrequired
  • pricebook_saveItem16 params

    Add a price book item, or change one when item_id is given (owner or office). AI can draft a quote line from an item. The owner approves it before the quote is sent.

    Show parameters
    • shop_idstringrequired
    • item_idstring
    • kindstringtask: a flat rate task that bundles labor and parts at one price
    • namestring
    • descriptionstring
    • unitstringeach, hour, foot, and so on
    • cost_minorintegerWhat it costs the shop, in cents. Never shown to customers.
    • unit_price_minorintegerPrice to the customer, in cents
    • markup_percentnumberInstead of unit_price_minor: price = cost times (1 + markup/100), rounded to the cent
    • taxableboolean
    • categorystringCategory name; made if new
    • task_codestringTasks only: the shop's code, like AC-CAP. Unique in the shop. Empty string clears it.
    • est_minutesintegerTasks only: estimated labor minutes, for costing
    • member_price_minorinteger | nullTasks only: price for customers on an active maintenance plan, in cents. Not above the price. null clears it.
    • warranty_notestringShown to the customer with the task, like 1 year parts and labor. Empty string clears it.
    • partsarrayTasks only: the price book materials the task uses, for costing. Never shown as a price and never taken from stock on its own.
  • pricebook_list4 params

    List the shop's price book items, by name. Filter by category or text; archived items are left out unless asked for. cost_minor is null for a worker the owner has not let see costs.

    Show parameters
    • shop_idstringrequired
    • categorystring
    • qstring
    • include_archivedboolean
  • pricebook_archiveItem2 params

    Archive a price book item, or bring it back with archived false (owner or office). Quotes that used it keep their lines.

    Show parameters
    • item_idstringrequired
    • archivedboolean
  • templates_save5 params

    Save a quote template: worker-written lines (and good, better, best options) to start quotes from. Give template_id to replace one (owner or office).

    Show parameters
    • shop_idstringrequired
    • template_idstring
    • namestringrequired
    • linesarrayrequired
    • optionsarrayGood, better, best: 2 to 5 options the customer chooses one of when signing. Each needs its own lines.
  • templates_list2 params

    List the shop's saved quote templates with their lines. To use one, pass its lines and options to quotes.create, changed as the worker says.

    Show parameters
    • shop_idstringrequired
    • include_archivedboolean
  • templates_archive2 params

    Archive a quote template, or bring it back with archived false (owner or office).

    Show parameters
    • template_idstringrequired
    • archivedboolean
  • quotes_activity1 param

    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.

    Show parameters
    • quote_idstringrequired
  • shops_setQuoteFollowup2 params

    Set how many days after a quote is sent the customer gets one friendly follow-up email if they have not answered (owner only). 0 turns it off. Default 3.

    Show parameters
    • shop_idstringrequired
    • daysintegerrequired
  • invoices_create6 params

    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). Optional due date, memo and deposit. Send it with invoices.send.

    Show parameters
    • job_idstringrequired
    • linesarrayrequired
    • due_onstring
    • memostring
    • deposit_minorinteger
    • tax_rate_idstring | nullTax rate to charge. Leave out for the shop default rate; null for no tax.
  • invoices_createBatch3 params

    Create many invoices at once (up to 100), each from a job and the lines the worker wrote. All or nothing. With send=true each is sent and its pay link returned. An agent cannot send lines it drafted; a person who can send invoices does that.

    Show parameters
    • shop_idstringrequired
    • sendboolean
    • itemsarrayrequired
  • invoices_get1 param

    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. payments lists each card or bank payment: id is the charge_id invoices.refund takes, plus amount, method, status, paid_at, refunded amount and refunds. refunded_minor is money sent back. net_collected_minor is what remains of the payment after that. A payment status is refunded or partially_refunded once the processor confirms. collected_minor stays the amount that was paid, and balance_minor stays what is still owed, which is 0 after a refund. display_status is payment_pending while a bank payment clears (3 to 5 business days), otherwise the invoice status. last_bank_payment_failed_at is set when the latest bank payment failed and the customer can pay again.

    Show parameters
    • invoice_idstringrequired
  • invoices_list5 params

    Invoices in one shop, newest first. Filter by status or by a customer name or invoice id. Read only. A shop you are not a member of is refused. Seeing the amounts needs see_prices, the same as invoices.get.

    Show parameters
    • shop_idstringrequired
    • statusstring
    • qstring
    • limitintegerHow many rows to return. Default 50 when you leave it out. An integer, or a numeric string such as "50".
    • cursorstring
  • invoices_pdf1 param

    The invoice as a PDF (base64), with shop, customer, lines, paid so far and balance. Attach it to email or save it.

    Show parameters
    • invoice_idstringrequired
  • invoices_aging3 params

    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.

    Show parameters
    • shop_idstringrequired
    • as_ofstring
    • limitintegerAccepted and ignored. Aging has no page. Totals include every open invoice. List ops default to 50 rows when limit is left out.
  • payments_list3 params

    Card and bank payments in one shop, newest first. Each id is the charge_id invoices.refund takes. Read only. A shop you are not a member of is refused. Amounts need see_prices.

    Show parameters
    • shop_idstringrequired
    • limitintegerHow many rows to return. Default 50 when you leave it out. An integer, or a numeric string such as "50".
    • cursorstring
  • payments_get1 param

    One card or bank payment, with the amount sent back and each refund. id is the charge_id invoices.refund takes. Read only. A payment in a shop you are not a member of is not found. Amounts need see_prices.

    Show parameters
    • charge_idstringrequired
  • shops_setTips2 params

    Turn tips on or off on this shop's invoice pay page (owner only). Off by default. A tip is paid with the invoice, never counts toward the invoice total, and shows in tips.report.

    Show parameters
    • shop_idstringrequired
    • enabledbooleanrequired
  • shops_setReviewRequest4 params

    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). No link means no email. Default 1 day; 0 turns it off. Review emails show the shop name and mailing_address in the footer, so a link can only be set once the shop has a mailing address (send it here).

    Show parameters
    • shop_idstringrequired
    • review_urlstring
    • mailing_addressstring
    • daysinteger
  • tips_report3 params

    Tips customers paid, by invoice and in total, between two dates (owner or office). Tips are kept apart from invoice totals. Refunds of a payment are not split out from its tip.

    Show parameters
    • shop_idstringrequired
    • fromstringrequiredYYYY-MM-DD
    • tostringrequiredYYYY-MM-DD, inclusive. Dates are in the shop's own time zone.
  • shops_getBrand1 param

    How this shop's quotes and invoices look: accent color, license number, footer text, logo size, and whether "Sent with Doing Work" shows.

    Show parameters
    • shop_idstringrequired
  • shops_setBrand7 params

    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). The owner can also change it on the brand page at /p/shop/brand. Send only what changes; null clears a field. The footer is footer or footer_text (the same field). accent_color is "#rrggbb" and must reach 4.5 to 1 contrast on white (the default is #1f4fd1). logo_base64 is a PNG or JPEG of up to 5 MB, stored as a JPEG of at most 600 pixels on its long side. sent_with_doing_work (on by default) prints "Sent with Doing Work" in the PDF footer, on the page and at the bottom of emails.

    Show parameters
    • shop_idstringrequired
    • accent_colorstring | null"#rrggbb", dark enough to read on white. null goes back to the default.
    • license_numberstring | nullUp to 80 characters, printed as "License ...".
    • footerstring | nullUp to 300 characters printed at the bottom, such as payment terms or a thank you.
    • footer_textstring | nullSame as footer. Either name is accepted.
    • sent_with_doing_workboolean
    • logo_base64string | nullA PNG or JPEG file, base64. null removes the logo.
  • quotes_pdf2 params

    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. The date is in the shop's time zone (priv.shop_time_zone: the shop's own zone, otherwise its state's). The file is named Q-10.pdf from doc_no, or quote- plus the id when there is no number. An unsent draft's footer says Draft instead of Sent with Doing Work. Financing links use the signed total once the customer has signed, and the lowest option until then. The latest version unless version is given. Attach it to email or save it.

    Show parameters
    • quote_idstringrequired
    • versioninteger
  • cards_setupLink1 param

    Get a secure page where the customer saves a card with the shop's payment processor (owner or office). Send the link to the customer; Doing Work never sees the card number. Saving a new card replaces the old one.

    Show parameters
    • customer_idstringrequired
  • cards_get1 param

    The card a customer has on file (brand, last 4, expiry) and whether auto-pay is on (owner or office).

    Show parameters
    • customer_idstringrequired
  • cards_remove1 param

    Remove a customer's saved card (owner or office). Auto-pay turns off with it.

    Show parameters
    • customer_idstringrequired
  • customers_setAutopay2 params

    Turn auto-pay on or off for a customer (owner or office). On needs a saved card. With auto-pay on, each invoice sent to them is charged to the card on its due date (or the day it is sent if it has none). A failed charge is not retried; you get an email and the pay link still works.

    Show parameters
    • customer_idstringrequired
    • enabledbooleanrequired
  • maintenance_createPlan10 params

    Start a maintenance plan for a job's customer (owner or office). AI can draft the priced lines for one term; the owner approves them before the plan is sent. The first term's invoice is created now (and sent if send_first is true). When a term ends, the next term's invoice is created automatically and sent if auto_send is on. With visits_per_term, each term also gets that many service due dates (see services.listDue), so the shop knows when each covered visit is due; schedule the actual visit with visits.create as usual.

    Show parameters
    • job_idstringrequired
    • namestringrequired
    • term_monthsintegerrequired
    • starts_onstring
    • linesarrayrequired
    • tax_rate_idstring | nullTax rate each term charges. Leave out for the shop default rate; null for no tax.
    • auto_sendboolean
    • send_firstboolean
    • visits_per_termintegerVisits the plan covers each term, for example 2 for two tune-ups a year. Each term gets that many service due dates, spread evenly from the term's start. Defaul
    • visit_titlestringWhat each visit is called, for example "Furnace tune-up". Default: the plan name and "visit".
  • maintenance_getPlan1 param

    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.

    Show parameters
    • plan_idstringrequired
  • maintenance_listPlans3 params

    A shop's maintenance plans, optionally for one customer or by status, soonest renewal first.

    Show parameters
    • shop_idstringrequired
    • customer_idstring
    • statusstring
  • maintenance_setPrice3 params

    Replace a plan's priced lines (owner or office), and optionally its tax rate. An agent can only propose the lines: they wait until the owner or office confirms them with maintenance.confirmPrice. A person who is the owner or office writes them now. Applies from the next term's invoice; invoices already made keep their price.

    Show parameters
    • plan_idstringrequired
    • linesarrayrequired
    • tax_rate_idstring | nullTax rate each term charges. Leave out to keep the plan's current rate; null for no tax.
  • maintenance_setVisits4 params

    Change how many visits a plan covers each term, and what they are called (owner or office). Applies from the next term. Pass this_term true to also add them now to the current term when it has none yet.

    Show parameters
    • plan_idstringrequired
    • visits_per_termintegerrequiredVisits the plan covers each term, for example 2 for two tune-ups a year. Each term gets that many service due dates, spread evenly from the term's start. Defaul
    • visit_titlestringWhat each visit is called, for example "Furnace tune-up". Default: the plan name and "visit".
    • this_termboolean
  • maintenance_cancelPlan1 param

    Cancel a maintenance plan (owner or office). No more renewal invoices. Invoices already sent stay as they are. The plan's open visit due dates are cancelled.

    Show parameters
    • plan_idstringrequired
  • taxes_saveRate6 params

    Add or change a sales tax rate the shop charges in one jurisdiction (owner or office). You enter the rate; Doing Work never looks it up. rate_bps is hundredths of a percent (600 = 6%). Changing a rate applies to new quotes and invoices only. is_default makes it the rate used when a quote or invoice does not name one.

    Show parameters
    • shop_idstringrequired
    • tax_rate_idstring
    • namestringrequired
    • jurisdictionstringrequiredWhere it applies, as you name it, for example "ID Kootenai County"
    • rate_bpsintegerrequired
    • is_defaultboolean
  • taxes_listRates2 params

    The shop's tax rates. Archived (replaced or removed) rates are left out unless include_archived is true.

    Show parameters
    • shop_idstringrequired
    • include_archivedboolean
  • taxes_archiveRate1 param

    Stop using a tax rate (owner or office). Quotes and invoices that already used it keep it.

    Show parameters
    • tax_rate_idstringrequired
  • shops_setTaxReportBasis2 params

    Choose how the sales tax report counts a period (owner only). accrual (default): invoices sent in the period. cash: money collected in the period, after refunds. Pick the one your state files on.

    Show parameters
    • shop_idstringrequired
    • basisstringrequired
  • taxes_salesReport4 params

    Sales tax report for a period (owner or office), shop local dates, from and to inclusive. Uses the shop's basis (shops.setTaxReportBasis) unless basis is given. accrual: invoices sent in the period, with sales, taxable sales, tax billed, and tax collected so far. cash: money collected in the period through Doing Work (payments minus refunds, tips left out), with the tax share of it. Grouped by the tax name, jurisdiction and rate on each invoice. Untaxed sales are one row with no rate. Void invoices are left out. For filing, check the numbers against your own records.

    Show parameters
    • shop_idstringrequired
    • fromstringrequired
    • tostringrequired
    • basisstring
  • quotes_addAttachment3 params

    Show an uploaded photo or file of the same job with a quote, with an optional caption. Upload it first with the media ops. The customer sees it on the quote page.

    Show parameters
    • quote_idstringrequired
    • media_idstringrequired
    • captionstring
  • quotes_removeAttachment1 param

    Take a photo or file off a quote. The media item itself stays on the job.

    Show parameters
    • attachment_idstringrequired
  • quotes_listAttachments1 param

    Photos and files shown with a quote, in order.

    Show parameters
    • quote_idstringrequired
  • media_tag3 params

    Add or remove tags on a photo (for example: leak, panel, permit). Tags are lower case; returns the photo's tags.

    Show parameters
    • media_idstringrequired
    • addarray
    • removearray
  • tags_list1 param

    Every tag used in the shop, with how many photos and jobs carry it.

    Show parameters
    • shop_idstringrequired
  • media_search7 params

    Find photos across the shop that carry all the given tags. Narrow by job, stage, or upload dates (shop time zone). Newest first, up to 200.

    Show parameters
    • shop_idstringrequired
    • tagsarray
    • job_idstring
    • stagestring
    • fromstringYYYY-MM-DD
    • tostringYYYY-MM-DD, inclusive
    • limitinteger
  • jobs_findByTag2 params

    Jobs in the shop that carry all the given tags (set with jobs.setTags), newest first, up to 200.

    Show parameters
    • shop_idstringrequired
    • tagsarrayrequired
  • media_saveMarkup2 params

    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). The photo is never changed; earlier versions are kept. An empty list clears the markup.

    Show parameters
    • media_idstringrequired
    • shapesarrayrequired
  • media_getMarkup2 params

    A photo's markup: the latest version unless one is named, with an SVG overlay to lay over the original photo. Also lists all versions.

    Show parameters
    • media_idstringrequired
    • versioninteger
  • shares_create6 params

    Make a link to a gallery of a job's photos that anyone with the link can open without signing in. Name the photos, or leave media_ids out to share every photo on the job (including ones added later). When object storage is configured, videos on the job can be included too. Expires after days (1 to 90, default 14); revoke it any time. Markup shows over the photos unless include_markup is false. Set include_daily_log to also show the job's daily log entries (off by default; names of who wrote them are not shown). The url is shown once.

    Show parameters
    • job_idstringrequired
    • media_idsarray
    • daysinteger
    • titlestring
    • include_markupboolean
    • include_daily_logboolean
  • shares_list1 param

    Photo share links on a job, newest first, with whether each is still active and how often it was opened. The link itself is not shown again.

    Show parameters
    • job_idstringrequired
  • shares_revoke1 param

    Turn a photo share link off now. Anyone opening it after this sees that it is no longer available.

    Show parameters
    • share_idstringrequired
  • logs_add4 params

    Write a daily log entry on a job: what happened on site that day, in the worker's own words. Any shop member can add one. log_date defaults to today in the shop's time zone. Attach photos already on the job with media_ids.

    Show parameters
    • job_idstringrequired
    • bodystringrequired
    • log_datestring
    • media_idsarray
  • logs_list3 params

    Daily log entries on a job, oldest first, optionally between two dates (inclusive). Removed entries are left out.

    Show parameters
    • job_idstringrequired
    • fromstring
    • tostring
  • logs_remove1 param

    Take a daily log entry out of the log. Only the worker who wrote it or the owner can. It stays in history and in any PDF already made.

    Show parameters
    • entry_idstringrequired
  • documents_photoReport4 params

    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. Name photos with media_ids or leave it out for every photo on the job. Core stores the PDF with its sha256 and returns it (base64).

    Show parameters
    • job_idstringrequired
    • titlestring
    • notesstring
    • media_idsarray
  • documents_dailyLog4 params

    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. Optional from and to dates (inclusive). Core stores the PDF with its sha256 and returns it (base64).

    Show parameters
    • job_idstringrequired
    • fromstring
    • tostring
    • include_photosboolean
  • documents_list1 param

    PDF documents core made for a job (photo reports, daily logs and submitted forms), newest first, with each file's sha256.

    Show parameters
    • job_idstringrequired
  • documents_get1 param

    One stored job PDF (base64) with its sha256, byte for byte as it was made.

    Show parameters
    • document_idstringrequired
  • expenses_add8 params

    Record money a worker spent on a job, with the receipt photo. Parts received on a purchase order are already job cost; when the vendor matches a received purchase order on the job, possible_po_duplicates lists it so you can ask before keeping both. The worker types the amount and tax from the receipt; core never reads or fills in amounts. spent_on defaults to today in the shop's time zone.

    Show parameters
    • job_idstringrequired
    • spent_onstring
    • vendorstring
    • categorystring
    • amount_minorintegerrequiredTotal paid in cents, typed by the worker from the receipt.
    • tax_minorintegerTax part of amount_minor, typed by the worker. Default 0.
    • receipt_media_idstring
    • notestring
  • expenses_update8 params

    Change an expense: date, vendor, category, amount, tax, receipt photo or note. Amounts are still typed by a worker. The worker who entered it, the owner or office can change it.

    Show parameters
    • expense_idstringrequired
    • spent_onstring
    • vendorstring
    • categorystring
    • amount_minorintegerTotal paid in cents, typed by the worker from the receipt.
    • tax_minorintegerTax part of amount_minor, typed by the worker. Default 0.
    • receipt_media_idstring
    • notestring
  • expenses_remove1 param

    Take an expense off the books (kept in history). The worker who entered it, the owner or office can.

    Show parameters
    • expense_idstringrequired
  • expenses_list5 params

    Expenses on a job, or across the shop between dates, with totals by category. Owner and office see every expense; a field worker sees the ones they entered.

    Show parameters
    • job_idstring
    • shop_idstring
    • fromstring
    • tostring
    • categorystring
  • search_global3 params

    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). Case-insensitive; you see only what your role can read.

    Show parameters
    • shop_idstringrequired
    • qstringrequired
    • limitinteger
  • events_catalog

    Every event a webhook can receive, with its payload keys and types. Approved agent actions add requested_by_token_id to any event.

  • webhooks_deliveries4 params

    List deliveries to one webhook endpoint, newest first, with event, status, attempts and last HTTP status.

    Show parameters
    • endpoint_idstringrequired
    • statusstring
    • limitinteger
    • before_idinteger
  • webhooks_retry1 param

    Send a failed or dead delivery again from attempt 0 (owner or office).

    Show parameters
    • delivery_idintegerrequired
  • imports_fields

    The customer import fields and the built-in presets (jobber, housecall_pro, servicetitan, companycam) with the export column each reads.

  • imports_preview6 params

    Dry run of a customer CSV import. Writes nothing. Returns the headers, a suggested mapping (from a preset or the header names), and for every row the customer it would create or the problems found. Show the mapping to the owner before imports.run. next_actions says what to do next.

    Show parameters
    • shop_idstringrequired
    • csvstringrequired
    • presetstring
    • mappingarray
    • sourcestringWhere the file came from (jobber, housecall_pro, ...). Old ids are remembered per source. Defaults to the preset, or csv.
    • on_matchstringA row that matches a customer already in Doing Work (by old id, then email, then phone): skip (default) leaves it; update fills blanks, adds tags and a new serv
  • imports_run8 params

    Owner only: import customers (and one service address each) from a CSV with the mapping the owner confirmed. mode all_or_nothing (default) writes nothing if any row fails; per_row writes the good rows and reports the rest. dry_run true checks without writing.

    Show parameters
    • shop_idstringrequired
    • csvstringrequired
    • mappingarrayrequired
    • modestring
    • dry_runboolean
    • sourcestringWhere the file came from (jobber, housecall_pro, ...). Old ids are remembered per source. Defaults to the preset, or csv.
    • on_matchstringA row that matches a customer already in Doing Work (by old id, then email, then phone): skip (default) leaves it; update fills blanks, adds tags and a new serv
    • preview_hashstringThe preview_hash from imports.preview, 64 hex characters. When sent, the run is refused if the file or mapping changed since that preview.
  • 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. imports.historyPreview include_won also keeps won and declined quotes as history for pricing. Quote files may add a size: a Unit or UOM column with quantity, or a column whose header is the unit (Sq Ft, Square Feet, Linear Feet, LF). The preview shows that size. The description is used only when no size column is mapped. The Jobber preset is beta: its column names may not match a real export. We import what we can and skip the rest.

  • imports_historyPreview10 params

    Dry run of a history import (kind jobs, quotes, invoices, pricebook, equipment, maintenance_plans, payments or flat_rate). Writes no shop data. Returns a suggested mapping, what each record would do (create, update, skip, skip_blank, skip_closed or error) with how its customer matched, and a preview_hash. Show it to the owner; imports.historyRun needs the same hash. include_won true (quotes only) imports won and declined quotes as history instead of skip_closed. History prices later drafts and is never sent or billed. Quote rows with a size column include sizes (400 sq ft) so the owner can confirm. A column header that is a unit supplies that unit. The description is used only when no size column is mapped. The Jobber preset is beta. Columns it cannot map are skipped, the summary says what would be skipped and why, and that skip is logged (column names and a short reason only).

    Show parameters
    • shop_idstringrequired
    • plans_asstringmaintenance_plans only. reminders (default): service due reminders, no money. billed: real maintenance plans at the price per term in the file, which the owner
    • include_wonbooleanQuotes only. true imports won quotes (approved, accepted, signed, won, converted) as signed history and declined quotes as declined history. History prices new
    • kindstringrequired
    • csvstringrequired
    • sourcestringWhere the file came from, like jobber or housecall_pro. Old ids are remembered per source. Defaults to the preset, or csv.
    • on_matchstringWhat to do with a record already imported (same old id) or already in Doing Work. skip (default) leaves it as it is; update refreshes jobs (summary, status, new
    • mappingarray
    • equipment_kindstringequipment kind only: the type for every row when the file has no type column, like Furnace for a Jobber custom field "Furnace Model". Guessed from the column na
    • presetstring
  • imports_historyRun11 params

    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). Records already imported are matched by old id and skipped or updated, never duplicated. Imported open quotes and invoices are drafts and are not sent. With include_won, won and declined quotes are imported as history: they price later drafts, and they are never sent, invoiced, followed up, or shown as signed work to bill. Maintenance plans become service-due reminders (no invoice, no charge), or with plans_as billed, maintenance plans at the confirmed price with auto_send off and no invoice until the next due date; payments become read-only history records (no charge, no fee, no invoice change). flat_rate rows become price book tasks, matched by old id, then task code, then name. mode all_or_nothing (default) or per_row. The Jobber preset is beta: a row or column it cannot map is skipped, the rest are imported, and the summary says what was skipped and why.

    Show parameters
    • shop_idstringrequired
    • plans_asstringmaintenance_plans only. reminders (default): service due reminders, no money. billed: real maintenance plans at the price per term in the file, which the owner
    • include_wonbooleanQuotes only. true imports won quotes (approved, accepted, signed, won, converted) as signed history and declined quotes as declined history. History prices new
    • kindstringrequired
    • csvstringrequired
    • sourcestringWhere the file came from, like jobber or housecall_pro. Old ids are remembered per source. Defaults to the preset, or csv.
    • on_matchstringWhat to do with a record already imported (same old id) or already in Doing Work. skip (default) leaves it as it is; update refreshes jobs (summary, status, new
    • mappingarrayrequired
    • equipment_kindstringequipment kind only: the type for every row when the file has no type column, like Furnace for a Jobber custom field "Furnace Model". Guessed from the column na
    • preview_hashstringrequiredThe preview_hash from imports.historyPreview, 64 hex characters.
    • modestring
  • imports_paymentHistory3 params

    Owner or office: payments imported from another system (read-only history; never charged, never counted toward Doing Work fees). Filter by customer_id.

    Show parameters
    • shop_idstringrequired
    • customer_idstring
    • limitinteger
  • shops_export4 params

    Owner only: everything the shop holds as one ZIP: data/<table>.csv and data/<table>.json for every shop table, files/ with job photos (and the original HEIC or TIFF file next to its JPEG copy) and PDFs, and manifest.json. Signing secrets and token hashes are left out. By default you get download_url, a link that works for 60 minutes and up to 5 downloads; anyone with the link can download, so do not share it. delivery "inline" returns zip_base64 instead, only for exports up to 10 MB. Large shops: pass include_files false for data only.

    Show parameters
    • shop_idstringrequired
    • include_filesboolean
    • deliverystringlink (default): a short-lived download_url. inline: zip_base64 in the response, up to 10 MB.
    • link_minutesintegerHow long the download link works. Default 60.
  • keys_list3 params

    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. Keys don't expire; revoke a key the shop no longer uses. The key itself is never returned. Filter by audience (any or mcp) or include revoked keys.

    Show parameters
    • shop_idstringrequired
    • audiencestring
    • include_revokedboolean
  • keys_revoke2 params

    Revoke a named agent key (owner only). It stops working at once and cannot be turned back on; make a new key instead.

    Show parameters
    • key_idstringrequired
    • reasonstring
  • keys_connections2 params

    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. Any worker can connect an agent that acts as themselves; the owner sees all of them.

    Show parameters
    • shop_idstringrequired
    • include_revokedboolean
  • keys_revokeConnection2 params

    Revoke an outside agent a worker connected through OAuth (owner only). Its access and refresh tokens stop at once. A connection that reaches all of that worker's shops ends everywhere.

    Show parameters
    • shop_idstringrequired
    • connection_idstringrequired
  • agents_register6 params

    Preferred when you know the owner's email: type service_auth and login_hint. The reply's short fields come first: claim_attempt_token, user_code, claim_token, claim_page, then verification_uri. Use verification_uri only when its length matches verification_uri_length. If it was cut, build the link from claim_page and claim_attempt_token. Do not invent the host. Do not open claim_url alone. Do not register again when complete is missing and claim_token is present; call the claim endpoint once only if claim_attempt_token is missing. Omitted scope means full `agent`. On an OAuth person grant (no shop_id) that can create a shop. A key from agents.register is bound to the shop the owner picks and cannot create another shop. read_only cannot. type anonymous only when you do not yet have the email. identity_assertion is not accepted.

    Show parameters
    • typestringrequired
    • login_hintstring
    • assertion_typestring
    • assertionstring
    • client_namestring
    • scopestring
  • agents_claim2 params

    auth.md claim. Pass your claim_token and the email of the shop owner who should claim you. You get a 6 digit user_code and a verification_uri: tell the person to open the link, sign in with that email and type the code. Then poll the token endpoint with grant_type urn:workos:agent-auth:grant-type:claim. Calling again with the same claim_token starts a fresh code and cancels the old one.

    Show parameters
    • claim_tokenstringrequired
    • emailstringrequired
  • reports_revenue3 params

    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.

    Show parameters
    • shop_idstringrequired
    • fromstringrequired
    • tostringrequired
  • reports_owed1 param

    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.

    Show parameters
    • shop_idstringrequired
  • reports_quoteWinRate3 params

    Of the quotes made between two dates (inclusive, UTC) and sent, how many were signed, declined, or are still waiting. Win rate is signed over signed plus declined; null when none are decided yet.

    Show parameters
    • shop_idstringrequired
    • fromstringrequired
    • tostringrequired
  • members_permissions2 params

    What each current worker in a shop may do beyond their role: see_prices, see_costs, take_money, delete and manage_schedule. Roles are owner, office, lead and field. The owner sees everyone; anyone else sees only themselves. The owner always has every permission. A new field worker starts with see_prices off. A new lead starts with see_prices, see_costs, take_money and delete off, and manage_schedule on.

    Show parameters
    • shop_idstringrequired
    • person_idstring
  • shops_sendPermissions1 param

    What each role may send to a customer: quotes, invoices and visit recaps. The owner always may, for every job, and is not listed. Office starts able to send all three for any job. A lead starts able to send all three for jobs on their crew. A field worker starts able to send all three for jobs assigned to them. The owner can turn any of these off. A missing row means the default, which is on.

    Show parameters
    • shop_idstringrequired
  • legal_documents

    The legal documents Doing Work asks people to accept, with the current version and a link to the text. A document marked placeholder has no text yet and cannot be accepted.

  • 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.

  • legal_shopTerms1 param

    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. Any member of the shop can read it. The owner accepts and opts out on the page in page_url.

    Show parameters
    • shop_idstringrequired
  • shops_signUp10 params

    Create a shop for an owner who has already accepted the current Terms and Privacy. That acceptance is for the person and covers every shop they own or join. Send accept_terms true, the shop name, the jurisdiction and the owner's name and email. This does not accept for the owner and it does not email the Terms. If the owner has not accepted yet, the call is refused and names the missing document and /p/legal. The reply has an agent key for the new shop, shown once.

    Show parameters
    • shop_namestringrequired
    • jurisdictionstringrequiredFor example US-ID
    • owner_namestringrequired
    • owner_emailstringrequired
    • accept_termsbooleanrequiredtrue: the owner already accepted the current Terms and Privacy. One acceptance covers every shop.
    • accept_terms_versionstringOptional: the Terms version you reviewed (now terms-2026-11-21a). Refused if it is not the current one.
    • agent_namestringYour name, used as the key label
    • partner_codestringOptional affiliate partner or referral code for this shop.
    • referral_codestringOptional alias for partner_code.
    • lead_codestringOptional internal acquisition or campaign tracking code for this shop.
  • signatures_request9 params

    Ask someone to sign a document on a hosted page, and get the signing link to give them. kind contract: text is the agreement exactly as the shop wrote it (Doing Work never writes contract or legal wording). kind job_document: a stored job PDF (documents.list). The signer signs in, reads it, types their name and agrees to sign electronically. Agents can never sign.

    Show parameters
    • kindstringrequired
    • job_idstring
    • customer_idstring
    • titlestringrequiredWhat the signer sees as the heading, for example Service agreement.
    • textstringkind contract: the full text to sign, written by the shop.
    • document_idstringkind job_document: the stored PDF to sign.
    • signer_rolestringcustomer (default): someone outside the shop; a shop member cannot sign it for them. member: a worker in the shop signs.
    • signer_emailstringOnly this signed-in email may sign. Leave out to let whoever opens the link and signs in sign.
    • link_daysintegerDays the signing link works (default 14).
  • signatures_newLink2 params

    A new signing link for an open signature request. Earlier links for it stop working.

    Show parameters
    • signature_request_idstringrequired
    • link_daysintegerDays the signing link works (default 14).
  • signatures_cancel1 param

    Cancel an open signature request. Its links stop working. A signed document stays signed.

    Show parameters
    • signature_request_idstringrequired
  • signatures_get1 param

    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).

    Show parameters
    • signature_request_idstringrequired
  • signatures_list7 params

    Signature requests for a job, a customer or a whole shop, newest first, with status and who signed. Filter by kind, status or subject_id.

    Show parameters
    • shop_idstring
    • job_idstring
    • customer_idstring
    • kindstring
    • subject_idstring
    • statusstring
    • limitinteger
  • checklists_saveTemplate6 params

    Create a checklist template, or replace one (give checklist_template_id). Items are in order; required items (the default) must be ticked before the visit or job can be marked done. Checklists already made from it keep their own copy.

    Show parameters
    • shop_idstringrequired
    • checklist_template_idstring
    • namestringrequired
    • descriptionstring
    • signoff_requiredbooleanChecklists from this template need a signed sign-off (checklists.requestSignOff) before done.
    • itemsarrayrequired
  • checklists_listTemplates2 params

    The shop's checklist templates with their items. Archived ones only with include_archived.

    Show parameters
    • shop_idstringrequired
    • include_archivedboolean
  • checklists_archiveTemplate1 param

    Archive a checklist template so it is no longer offered. Checklists made from it are unchanged.

    Show parameters
    • checklist_template_idstringrequired
  • checklists_create6 params

    Put a checklist on a job, or on one visit of the job (visit_id). Copy a template (checklist_template_id) or give items. A visit checklist gates that visit's done; a job checklist gates the job's done (jobs.complete), and the job also waits on checklists of visits not yet done.

    Show parameters
    • job_idstringrequired
    • visit_idstring
    • checklist_template_idstring
    • namestring
    • signoff_requiredbooleanNeeds a signed sign-off before done. Default: the template's setting, else false.
    • itemsarray
  • checklists_list2 params

    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. Workers see the checklists of the jobs they can see.

    Show parameters
    • job_idstring
    • visit_idstring
  • checklists_get1 param

    One checklist with every item (removed items included and marked), who ticked what and when, and its sign-off.

    Show parameters
    • checklist_idstringrequired
  • checklists_checkItem3 params

    Tick (done true) or untick an item, with an optional note. The worker on the visit (for a job checklist, on any visit of the job) or the office can do this. Locked once the visit or job is done, while a sign-off is waiting, and after sign-off.

    Show parameters
    • checklist_item_idstringrequired
    • donebooleanrequired
    • notestringReplaces the note; an empty string clears it.
  • checklists_addItems2 params

    Add items to the end of a checklist (owner or office). Same locks as ticking.

    Show parameters
    • checklist_idstringrequired
    • itemsarrayrequired
  • checklists_removeItem1 param

    Remove an item from a checklist (it stays in the history, marked removed). Owner or office; a required item only by the owner. Audited.

    Show parameters
    • checklist_item_idstringrequired
  • checklists_requestSignOff4 params

    Ask for a sign-off on a finished checklist and get the signing link. Every required item must be ticked. The signer (the customer by default, or a shop member) signs the checklist exactly as it stands; items lock while the sign-off waits (signatures.cancel unlocks).

    Show parameters
    • checklist_idstringrequired
    • signer_rolestring
    • signer_emailstringOnly this signed-in email may sign.
    • link_daysintegerDays the signing link works (default 14).
  • jobs_complete2 params

    Mark a job done (owner or office). Refused with checklist_open while a job checklist, a checklist on a visit not yet done, or a sign-off checklist on a cancelled visit, has required items open or a sign-off missing; the owner, signed in on the hosted override page (/p/checklist/override), may pass override_reason to mark it done anyway (recorded and audited). Agents, keys and office staff cannot override.

    Show parameters
    • job_idstringrequired
    • override_reasonstringOwner in person only (hosted override page): why the job is done with checklist work left.
  • forms_saveTemplate6 params

    Create a form template (an inspection, a safety sheet, a start-up report), or replace one (give form_template_id). Fields are in order; types: heading, text, long_text, number, yes_no, choice, multi_choice, date, photos. Forms already started keep their own copy. Owner or office.

    Show parameters
    • shop_idstring
    • form_template_idstring
    • namestringrequired
    • descriptionstring
    • fieldsarrayrequired
    • signoff_requiredbooleanThe shop wants a signature on this form after it is submitted (forms.requestSignOff). Shown on forms; not a gate.
  • forms_listTemplates2 params

    The shop's form templates with their fields. Archived ones only with include_archived.

    Show parameters
    • shop_idstringrequired
    • include_archivedboolean
  • forms_archiveTemplate1 param

    Archive a form template so it is no longer offered. Forms made from it are unchanged.

    Show parameters
    • form_template_idstringrequired
  • forms_start7 params

    Start a form on a job, or on one visit of the job (visit_id). Copy a template (form_template_id), copy an earlier form with its answers (copy_from_form_id: the way to correct a submitted form), or give name and fields. The owner, office, or a worker assigned on the job can start one. It starts as a draft.

    Show parameters
    • job_idstringrequired
    • visit_idstring
    • form_template_idstring
    • copy_from_form_idstring
    • namestring
    • fieldsarray
    • signoff_requiredboolean
  • forms_fill2 params

    Save answers on a draft form. answers is an object by field key; only the keys given change, and null clears one. Values: text for text/long_text, a number, true/false for yes_no, one option for choice, a list of options for multi_choice, YYYY-MM-DD for date, photo ids already on the job for photos.

    Show parameters
    • form_idstringrequired
    • answersobjectrequiredAnswers by field key; null clears one.
  • forms_submit1 param

    Submit a draft form: every required field must be answered (forms.get lists what is missing). Core renders the PDF, stores it on the job (a document of kind form, with its sha256) and freezes the form. Returns the form with the PDF (base64).

    Show parameters
    • form_idstringrequired
  • forms_cancel1 param

    Cancel a draft form (kept in history). A submitted form cannot be cancelled; start a corrected copy with forms.start copy_from_form_id.

    Show parameters
    • form_idstringrequired
  • forms_get1 param

    One form with its fields, answers, the required fields still missing, its stored PDF id and hash once submitted, and its sign-off.

    Show parameters
    • form_idstringrequired
  • forms_list3 params

    Forms on a job (job-level and per visit), or on one visit, newest first, without fields and answers. Filter by status.

    Show parameters
    • job_idstring
    • visit_idstring
    • statusstring
  • forms_requestSignOff4 params

    Ask for a signature on a submitted form and get the signing link (owner or office). The signer (the customer by default, or a shop member) signs the stored PDF exactly as submitted.

    Show parameters
    • form_idstringrequired
    • signer_rolestring
    • signer_emailstringOnly this signed-in email may sign.
    • link_daysintegerDays the signing link works (default 14).
  • notes_add11 params

    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). Any shop member can. Notes are internal to the shop and never shown to the customer. Set audience office to keep it to owner and office (owner or office only); notes on a worker or payment are always office. pinned keeps it at the top (owner or office only). Attach photos or videos already on the job with media_ids. Mention members to notify them; say what you need from them in the note. Write down what the worker tells you about a record here so the next person sees it. Pass channel when the words came from a text, an email, a call, or the visit (typed, email, call, text, visit). It is stored on the note.

    Show parameters
    • target_kindstringWhat the note is on. worker is a membership id, payment a charge id, media a photo or video id, shop the shop id. Notes on a worker or a payment are office only
    • target_idstring
    • job_idstring
    • visit_idstring
    • bodystringrequired
    • channelstringWhere the words came from: typed, email, call, text, or visit.
    • audiencestringteam (default): every shop member sees it. office: owner, office and the managing platform only.
    • pinnedboolean
    • media_idsarrayPhotos or videos already on the job.
    • mentionsarrayPerson ids of shop members to notify (team.list). They get an email unless they turned it off. Office notes can mention only owner and office. Customers are nev
    • agent_namestringYour agent's name, shown next to the writer, when an agent wrote the note for the worker.
  • notes_addVoiceMemo14 params

    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. Core runs no speech-to-text and does not keep the audio. Same rules as notes.add for who sees and pins it.

    Show parameters
    • target_kindstringWhat the note is on. worker is a membership id, payment a charge id, media a photo or video id, shop the shop id. Notes on a worker or a payment are office only
    • target_idstring
    • job_idstring
    • visit_idstring
    • transcriptstringrequired
    • duration_secondsintegerrequired
    • recorded_atstringWhen the memo was recorded. Not in the future.
    • transcribed_withstringWhat made the transcript, for example the speech model or app.
    • languagestringSpoken language as a BCP 47 tag, for example en or es-MX.
    • audiencestringteam (default): every shop member sees it. office: owner, office and the managing platform only.
    • pinnedboolean
    • media_idsarrayPhotos or videos already on the job.
    • mentionsarrayPerson ids of shop members to notify (team.list). They get an email unless they turned it off. Office notes can mention only owner and office. Customers are nev
    • agent_namestringYour agent's name, shown next to the writer, when an agent wrote the note for the worker.
  • notes_update6 params

    Change a note. Only the writer changes body, media_ids or mentions (each earlier wording is kept, up to 50 edits; newly mentioned members are notified). Owner or office can pin or unpin it and change audience. A removed note cannot change.

    Show parameters
    • note_idstringrequired
    • bodystring
    • media_idsarrayPhotos or videos already on the job.
    • mentionsarrayPerson ids of shop members to notify (team.list). They get an email unless they turned it off. Office notes can mention only owner and office. Customers are nev
    • pinnedboolean
    • audiencestringteam (default): every shop member sees it. office: owner, office and the managing platform only.
  • notes_remove2 params

    Take a note off its record. The writer, owner or office can. It stays in history with who removed it and why.

    Show parameters
    • note_idstringrequired
    • reasonstring
  • notes_get1 param

    One note you may see, with every earlier wording (history, oldest first).

    Show parameters
    • note_idstringrequired
  • notes_list7 params

    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). Pinned first, then newest first. Filter by source (typed or voice_memo); removed notes are left out unless include_removed is true. Read the notes on a record before you work on it.

    Show parameters
    • target_kindstringWhat the note is on. worker is a membership id, payment a charge id, media a photo or video id, shop the shop id. Notes on a worker or a payment are office only
    • target_idstring
    • job_idstring
    • visit_idstring
    • mentioning_mestring
    • sourcestring
    • include_removedstring
  • notes_search4 params

    Find notes you may see by their words, across every record in a shop. Optional target_kind narrows it. Newest first among the best matches. Search here before you ask the worker something the team may already have written down.

    Show parameters
    • shop_idstringrequired
    • qstringrequired
    • target_kindstringWhat the note is on. worker is a membership id, payment a charge id, media a photo or video id, shop the shop id. Notes on a worker or a payment are office only
    • limitinteger
  • notifications_getPrefs1 param

    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). Your own settings only.

    Show parameters
    • shop_idstringrequired
  • notifications_setPrefs4 params

    Turn mention emails or texts, or the night-before kit list email, on or off for yourself in one shop. Ask the worker before you change these. Texts stay held and unsent until the shop's texting registration is done.

    Show parameters
    • shop_idstringrequired
    • mention_emailboolean
    • mention_textboolean
    • kit_list_emailboolean
  • costs_job1 param

    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. Owner or office; needs seeing costs and prices.

    Show parameters
    • job_idstringrequired
  • costs_jobs6 params

    Job costing across jobs dated between two days (inclusive, in the shop's time zone), with totals. Sort by profit (lowest first, to find the losers), margin, or date. Up to 500 jobs; truncated says when more matched.

    Show parameters
    • shop_idstringrequired
    • fromstringrequired
    • tostringrequired
    • statusarrayOnly these job statuses. Default: every status except cancelled.
    • sortstringDefault profit (lowest first).
    • limitintegerDefault 200.
  • costs_marginAlert1 param

    The shop's profit alert: the margin floor in percent, or null when off. Owner or office.

    Show parameters
    • shop_idstringrequired
  • costs_setMarginAlert2 params

    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). It fires again only after the margin climbs back and drops again. The check reads job costing as you see it. null turns it off.

    Show parameters
    • shop_idstringrequired
    • below_percentnumber | nullrequired
  • crews_save5 params

    Save a named crew of workers to book together (owner or office). Give crew_id to rename it or replace its workers. lead_person_id marks the crew lead (a current member; they do not have to be in person_ids). Use the crew_id on visits.create, visits.assign or schedule.findTime. Shop roles are owner, office, lead and field.

    Show parameters
    • shop_idstringrequired
    • crew_idstring
    • namestringrequired
    • person_idsarrayrequired
    • lead_person_idstringThe crew lead. Omit to leave the current lead unchanged on an update, or none on a new crew. Null clears it.
  • crews_list2 params

    The shop's crews and their current workers. Any worker in the shop can read it. Archived crews only with include_archived.

    Show parameters
    • shop_idstringrequired
    • include_archivedboolean
  • crews_archive1 param

    Archive a crew (owner or office). Visits already booked keep their workers.

    Show parameters
    • crew_idstringrequired
  • financing_save7 params

    Save a financing link the shop works with, shown on quotes at or above its minimum (owner or office). Up to 3 live links. Doing Work does not process financing or charge any fee for it. The link goes to the shop's own financing company.

    Show parameters
    • shop_idstringrequired
    • financing_link_idstring
    • labelstringrequiredWhat the customer sees on the button, such as Goodleap or Synchrony.
    • urlstringrequiredAn https address at the financing company. Placeholder and reserved names (example.com, example.net, example.org, .example, .test, .invalid, localhost) and raw
    • notestring | nullOptional short note under the button. Null clears it.
    • min_total_minorinteger | nullShow this link only when the quote total (or the chosen option) is at least this many cents. Null means no minimum.
    • positioninteger1, 2 or 3. Leave out to take the next open spot.
  • financing_list2 params

    The shop's financing links. Any worker in the shop can read them. Archived links only with include_archived. Doing Work does not process financing or charge any fee for it. Each link goes to the shop's own financing company.

    Show parameters
    • shop_idstringrequired
    • include_archivedboolean
  • financing_archive1 param

    Archive a financing link so it no longer shows on quotes (owner or office). Doing Work does not process financing or charge any fee for it. The link goes to the shop's own financing company.

    Show parameters
    • financing_link_idstringrequired
  • reports_today2 params

    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. Each list shows the first 25 with the full count.

    Show parameters
    • shop_idstringrequired
    • datestringThe day to read, in the shop's time zone. Default: today there.
  • reports_week2 params

    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.

    Show parameters
    • shop_idstringrequired
    • week_ofstringAny day in the week to read. Default: today in the shop's time zone (this week so far).
  • reports_morningEmail1 param

    Whether the owner's morning email is on. It comes at 7 AM shop time, only on days it has something to show (for example jobs under the margin floor). Owner or office.

    Show parameters
    • shop_idstringrequired
  • reports_setMorningEmail2 params

    Turn the owner's morning email on or off (owner only).

    Show parameters
    • shop_idstringrequired
    • onbooleanrequired
  • schedule_kitList3 params

    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. Cancelled visits are left out. Quote prices show only to people who can see prices. A field worker gets only their own list.

    Show parameters
    • shop_idstringrequired
    • datestring
    • person_idstring
  • schedule_setKitListEmail3 params

    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. Default 18 (6 PM). Owner only.

    Show parameters
    • shop_idstringrequired
    • onbooleanrequired
    • hourinteger
  • tasks_create9 params

    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). Past due and still open, the worker gets one reminder email, then the owner is told once. Any worker on the shop can make one. for_agent true is the agent's own follow-up (recheck a quote, prompt the owner later): it is not emailed, and agent.due lists it when due_at has passed. op is the op to call then.

    Show parameters
    • shop_idstringrequired
    • titlestringrequired
    • job_idstring
    • assignee_idstring
    • note_idstring
    • due_onstring
    • due_atstring
    • for_agentboolean
    • opstring
  • tasks_list7 params

    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). Overdue first, then by due time. A field worker sees their own tasks, tasks they made and tasks on jobs they are booked on.

    Show parameters
    • shop_idstringrequired
    • assignee_idstring
    • job_idstring
    • statusstring
    • duestring
    • for_agentbooleantrue: only the agent's own follow-ups. false: only worker tasks. Leave out for both.
    • limitinteger
  • tasks_update6 params

    Change a task's title, job, worker or due time (due_on or due_at; null clears it). A new due time re-arms the one reminder. The owner, office, the worker it is for or the person who made it can change it.

    Show parameters
    • task_idstringrequired
    • titlestring
    • job_idstring | null
    • assignee_idstring | null
    • due_onstring | null
    • due_atstring | null
  • tasks_close3 params

    Close a task as done (default) or cancelled, with an optional note. A closed task is never chased.

    Show parameters
    • task_idstringrequired
    • statusstring
    • notestring
  • schedule_capacity5 params

    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. Give person_ids to check some workers. A field worker sees only themselves. Read only.

    Show parameters
    • shop_idstringrequired
    • fromstringFirst day, in the shop's time zone. Default today there.
    • daysintegerWorking days to read. Default 5.
    • visit_minutesinteger
    • person_idsarray
  • requests_leadSettings1 param

    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.

    Show parameters
    • shop_idstringrequired
  • requests_setLeadSettings5 params

    Change the shop's lead rules. Owner or office. auto_reply sends one first reply per new request: a text only where the customer already agreed to texts or texted the shop and the shop's number is approved, else an email, else nothing.

    Show parameters
    • shop_idstringrequired
    • auto_replyboolean
    • after_hoursstring
    • skiparray
    • flagarray
  • quotes_search5 params

    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. Matches the job summary and line items, most words matched first, signed quotes first at a tie, then newest. Read only. Prices show only to people who can see prices.

    Show parameters
    • shop_idstringrequired
    • qstringrequired
    • statusstring
    • exclude_job_idstring
    • limitinteger
  • visits_brief3 params

    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. Notes and media are paged (notes_cursor, media_cursor). Read only. Prices show only to people who can see prices. next_actions suggests what to do at or after the visit.

    Show parameters
    • visit_idstringrequired
    • notes_cursorstring
    • media_cursorstring
  • jobs_brief4 params

    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. Pass visit_id when the read is for one visit. notes_cursor and media_cursor fetch the next page. Read only. Prices show only to people who can see prices. Nothing is sent.

    Show parameters
    • job_idstringrequired
    • visit_idstring
    • notes_cursorstring
    • media_cursorstring
  • visits_addRecording9 params

    Add a walkthrough recording the worker sent you, during or after the visit. Listen to it yourself first: if it is clearly a different job or not a walkthrough, tell the worker and ask before you add it. Send what the worker said it is (described_as), your transcript, and recorded_at (when the clip was made, from the file) if you have it. Core keeps no audio: keep the clip on your side and send your clip_ref. The transcript and measurements become a voice memo note on the visit. worker_notes are private truck notes (things not said in front of the customer). They are stored on the recording only, not in that note, and are never fed into the recap. Do not put worker_notes in a recap, quote, scope of work, or anything the customer sees. Getting any consent the law requires to record is up to the worker and the shop.

    Show parameters
    • visit_idstringrequired
    • described_asstringWhat the worker said the clip is, in their words.
    • transcriptstringrequired
    • recorded_atstringWhen the clip was recorded, from the file. Default now.
    • duration_secondsinteger
    • transcribed_withstring
    • clip_refstringYour own reference to the clip (file name or id). Core never stores audio.
    • worker_notesstringPrivate truck notes: things not said in front of the customer. Stored on the recording, not in the transcript note. Never put these in a recap, quote, scope of
    • measurementsarray
  • visits_recordings1 param

    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. worker_notes are truck notes for the shop only. Never put them in a recap, quote, scope of work, or anything the customer sees.

    Show parameters
    • visit_idstringrequired
  • visits_draftRecap8 params

    Draft the recap email for the customer after a visit. For a detailed recap, pass body (the full email) or what_happened, options_discussed and next_steps. Leave those out to use the short template: what_we_saw in the worker's own words (or measurements from a saved recording) and the next step. Private worker_notes from a recording are never included, and a draft that contains them is refused. Nothing is sent: show the worker the draft, edit it with visits.editRecap, and send only when they approve with visits.approveRecap. Drafting again replaces the open draft.

    Show parameters
    • visit_idstringrequired
    • what_we_sawarray
    • next_stepstring
    • subjectstringEmail subject. Leave out for the usual subject.
    • bodystringThe full recap email. When set, this is the email and the short template is not used.
    • what_happenedstringWhat you and the customer went over, in sentences. Used when body is left out.
    • options_discussedstringOptions you talked through with the customer. Used when body is left out.
    • next_stepsstringWhat happens next, in sentences. Used when body is left out. next_step is the one line fallback for the short template.
  • visits_editRecap4 params

    Change the subject or words of a recap draft before the worker approves it. A draft that includes private worker notes from the visit is refused.

    Show parameters
    • recap_idstringrequired
    • subjectstring
    • bodystring
    • reasonstringWhy the worker changed it, in their words. Kept in the shop's corrections log for the next recap.
  • visits_approveRecap1 param

    Send the recap: it goes to the customer by email from the shop, with replies to the shop owner. Who may send is shops.sendPermissions: the owner always may, office for any job, a lead for jobs on their crew, and a field worker for jobs assigned to them, until the owner turns that off. Call only after that person says send it. Never call on your own. A recap that includes private worker notes is refused and is not sent.

    Show parameters
    • recap_idstringrequired
  • corrections_record7 params

    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). Keep the before, the after and the worker's reason in their words. You read these before your next draft for the shop.

    Show parameters
    • shop_idstringrequired
    • kindstringrequired
    • actionstringrequired
    • subject_idstring
    • beforestringThe words as they were, or as the worker left them.
    • afterstringThe words as they were, or as the worker left them.
    • reasonstring
  • corrections_recent3 params

    The shop's recent corrections to drafts you made, newest first: what was changed or rejected and why. Read these before you draft a quote, a recap or a reply for this shop, and follow them. A field worker sees the full rows of their own; recap and quote drafts already carry the whole shop's lessons, with no names.

    Show parameters
    • shop_idstringrequired
    • kindstring
    • limitinteger
  • quotes_draftFromVisit5 params

    Draft quote lines from a visit, in the worker's words and what you saw and heard. You set the price: read comparables and pricing_rules on the result (or call quotes.comparables), apply the shop's rules, and pass unit_price_minor or total_minor plus basis, a short note of how you got the price. That note is stored and read to the owner. Leave the price out and Doing Work fills a default from the closest signed quote, then the price book, then a past quote. The note says it is a default suggestion, not a scaled estimate. Comparables list every matching line (signed, sent, draft, declined, including imported history) with size, unit rate, total, customer, discounts and notes. Every line stays a draft until the worker approves, changes or rejects it (quotes.decideDraftLine). Optional scope_of_work (notes is the same field) is the written scope of work. It stays on the draft and quotes.finishDraft copies it onto the quote so the customer page and PDF show it. Do not put private worker notes in it. Nothing is sent. Read the returned lessons first and follow them.

    Show parameters
    • visit_idstring
    • job_idstring
    • scope_of_workstring | nullWritten scope of work for the customer quote page and PDF. notes is the same field. Null clears it. Do not include private worker notes.
    • notesstring | nullWritten scope of work for the customer quote page and PDF. notes is the same field. Null clears it. Do not include private worker notes.
    • linesarrayrequired
  • quotes_draft1 param

    Read one AI line draft from quotes.draftFromVisit, not a customer quote. Each line's state (draft, approved or rejected), where the price came from, the basis in source_note, comparables, the shop's pricing rules, the written scope_of_work, the shop's lessons, and the next line to read to the worker. For a customer quote, use quotes.get.

    Show parameters
    • draft_idstringrequired
  • quotes_decideDraftLine7 params

    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. basis is the short note of how the price was chosen, stored on the line and read to the owner. Call only with the worker's own answer, one line at a time. Changes and rejections are kept with the reason so the next draft gets it right.

    Show parameters
    • draft_line_idstringrequired
    • decisionstringrequired
    • descriptionstring
    • quantitynumber
    • unit_price_minorinteger
    • basisstringWhy this price, in a sentence the owner will hear.
    • reasonstringWhy, in the worker's words.
  • quotes_finishDraft4 params

    Make the quote from a draft once the worker decided every line. Only approved lines go on it, entered as the worker's. scope_of_work or notes on the draft is copied onto the quote as the written scope. Pass either here to set or replace it. The customer quote page and PDF show it. Do not include private worker notes. The quote is a draft: send it with quotes.send only when the worker says so.

    Show parameters
    • draft_idstringrequired
    • scope_of_workstring | nullWritten scope of work for the customer quote page and PDF. notes is the same field. Null clears it. Do not include private worker notes.
    • notesstring | nullWritten scope of work for the customer quote page and PDF. notes is the same field. Null clears it. Do not include private worker notes.
    • tax_rate_idstring | nullTax rate (taxes.listRates). Leave out for the shop default; null for no tax.

Showing the first 300 of 440 tools.

Checked by Serverdex with a plain initialize + tools/list call to doingwork.work/mcp, no credentials, about once a day. A failed check is never a removal.

On GitHub

read Nov 19, 2026
Stars
0
Forks
0
Last push
Nov 18, 2026
License
—

From the README

Doing Work MCP Server Free field service software for trade shops (doingwork.work). Your own AI agent runs customers, jobs, scheduling, quotes, invoices, and Stripe payments over MCP, REST, and A2A while you approve anything customer-facing. Remote MCP Endpoint • URL: https://doingwork.work/mcp • Transport: Streamable HTTP (POST https://doingwork.work/mcp) • MCP Protocol Versions: 2026-07-28 (server/discover), 2025-11-25, 2025-06-18 • Server Card: /.well-known/mcp/server-card.json • Authentication: OAuth 2.1 with PKCE and RFC 7591 Dynamic Client Registration (see auth.md and /.well-known/oauth-authorization-server), plus optional shop-scoped Bearer agent keys (dwk_...). Quickstart Prompt Copy and paste this into an always-on agent (such as Meta Muse, Grok Bot, ChatGPT Dots, or Claude Duet): Help me set up Doing Work using https://doingwork.work/docs/onboarding/. I need an always-on agent. Check the connection before proceeding.…

Read the full README on GitHub →

Remotes

  • streamable-httphttps://doingwork.work/mcp

The most-starred Business & CRM servers in the index, with their live-check result.

ServerStarsLast pushLive check
Contact Affordance7,477Nov 2026Working
Business Contact Finder7,470Nov 2026Working
JobSpy4,739Nov 2026Local / not checked
Relaticle1,915Nov 2026Needs sign-in
ChatbotX1,142Nov 2026Needs sign-in

Field Service Business Platform by Doing Work: questions people ask

Is Field Service Business Platform by Doing Work a remote or a local MCP server?
According to its entry in the official MCP registry, Field Service Business Platform by Doing Work ships as a hosted endpoint (streamable-http) that your client connects to by URL.
Does Field Service Business Platform by Doing Work need an API key?
Its hosted endpoint completed the Serverdex live check — an MCP initialize + tools/list call — with no credentials on Nov 22, 2026. Individual tools may still ask for a key when called.
Is Field Service Business Platform by Doing Work safe to use?
Mostly fine: Field Service Business Platform by Doing Work is maintained, hosted endpoint answering without a key. In detail — maintained: Active; official registry: Active; source: No licence found; runs: Hosted by the publisher; credentials: None needed to connect. Serverdex check of Nov 22, 2026. This is a reading of the repository, the registry entry and the live check, not a code audit; run the Serverdex security scan on the endpoint before trusting it with real data.
Is Field Service Business Platform by Doing Work still maintained?
Active: the repository's last commit 3 days ago. Last push Nov 18, 2026, 0 GitHub stars. Read from GitHub on Nov 19, 2026.
What tools does Field Service Business Platform by Doing Work expose?
440 tools as listed by the server itself during the live check, including auth_requestLink, auth_sendLink, auth_oauthRegister, auth_oauthAuthorize, auth_oauthToken. The full list with parameters is in the Live check section above.
How do I add Field Service Business Platform by Doing Work to Claude, Cursor or VS Code?
Copy the config in "Connect this server" into your client's MCP config file (claude_desktop_config.json, ~/.cursor/mcp.json or .vscode/mcp.json), or use the one-click Add to Cursor / Add to VS Code buttons and the one-line commands for Claude Code and Codex; then restart the client.
Browse all Business & CRM →

Add the badge to your site

Show visitors that Field Service Business Platform by Doing Work is listed here — it’s also the link we check for a free listing.

Field Service Business Platform by Doing Work — listed on Serverdex

HTML — for your website

<a href="https://serverdex.io/server/work-doingwork-shop?utm_source=badge"><img src="https://serverdex.io/brand/badge.svg" alt="Field Service Business Platform by Doing Work — listed on Serverdex" width="123" height="40" loading="lazy"></a>

Recommended. A dofollow link from your own domain is the one that counts for search engines, and it's the link we check for a free listing.

Markdown — for your README

[![Field Service Business Platform by Doing Work — listed on Serverdex](https://serverdex.io/brand/badge.svg)](https://serverdex.io/server/work-doingwork-shop?utm_source=badge)

Nice for visibility, but GitHub marks README links nofollow, so it doesn't pass authority. Use the HTML badge on your site as well.

Add to CursorAdd to VS CodeOpen in Claude Code

Install buttons — for your README

[![Add to Cursor](https://serverdex.io/brand/install-cursor.svg)](https://serverdex.io/install/cursor/work-doingwork-shop) [![Add to VS Code](https://serverdex.io/brand/install-vscode.svg)](https://serverdex.io/install/vscode/work-doingwork-shop) [![Open in Claude Code](https://serverdex.io/brand/install-claude-code.svg)](https://serverdex.io/install/claude-code/work-doingwork-shop)

One click opens Cursor or VS Code with this server's config prefilled; the Claude Code button lands on the one-line command. The links point at Serverdex, so when your config changes the buttons keep working.

Install buttons — HTML for your docs

<a href="https://serverdex.io/install/cursor/work-doingwork-shop"><img src="https://serverdex.io/brand/install-cursor.svg" alt="Add to Cursor — via Serverdex" width="140" height="28"></a>
<a href="https://serverdex.io/install/vscode/work-doingwork-shop"><img src="https://serverdex.io/brand/install-vscode.svg" alt="Add to VS Code — via Serverdex" width="147" height="28"></a>
<a href="https://serverdex.io/install/claude-code/work-doingwork-shop"><img src="https://serverdex.io/brand/install-claude-code.svg" alt="Open in Claude Code — via Serverdex" width="180" height="28"></a>

Same buttons as plain links for a docs page or website.

Prefer a live badge with the score, stars and live check? Score badge (links to a page that explains the number and back to this listing).