hub.view

The customer hub for the signed-in customer: their quotes, jobs, invoices with what is still owed, upcoming visits with any change request, requests with this shop, and their active maintenance plans (what each covers, the next visit due, price per term, renewal date and card on file). state is ok, gone (revoked, expired or unknown) or wrong_person (signed in with an email the shop does not have for this customer). Hosted page only.

WhoHosted page only (a person does it in the browser)
RESTGET /v1/hub/view
MCP toolNot an MCP tool
Writesno
AreaCustomer hub, requests and customer emails

When to use it

The customer hub for the signed-in customer: their quotes, jobs, invoices with what is still owed, upcoming visits with any change request, requests with this shop, and their active maintenance plans (what each covers, the next visit due, price per term, renewal date and card on file). state is ok, gone (revoked, expired or unknown) or wrong_person (signed in with an email the shop does not have for this customer).

What to tell the owner

Send the person the link. They finish this step themselves on the page; you never do it for them.

Input

FieldTypeRequired
kstringyes

Example

GET https://doingwork.work/v1/hub/view?k=...

Output

FieldTypeAlways there
statestringyes
link_idstring (uuid)no
shop_idstring (uuid)no
customer_idstring (uuid)no
shopstringno
customerstringno
time_zonestringno
expires_atstring (date-time)no
propertiesarrayno
properties[].property_idstring (uuid)yes
properties[].label['string', 'null']yes
properties[].addressstringyes
jobsarrayno
jobs[].job_idstring (uuid)yes
jobs[].summary['string', 'null']yes
jobs[].statusstringyes
jobs[].created_atstring (date-time)yes
quotesarrayno
quotes[].quote_idstring (uuid)yes
quotes[].job_idstring (uuid)yes
quotes[].summary['string', 'null']yes
quotes[].statusstringyes
quotes[].versionintegeryes
quotes[].total_minorintegeryes
quotes[].currencystringyes
quotes[].doc_nointegeryes
quotes[].doc_labelstringyes
quotes[].can_openbooleanyes
invoicesarrayno
invoices[].invoice_idstring (uuid)yes
invoices[].job_idstring (uuid)yes
invoices[].summary['string', 'null']yes
invoices[].statusstringyes
invoices[].total_minorintegeryes
invoices[].balance_minorintegeryes
invoices[].currencystringyes
invoices[].doc_nointegeryes
invoices[].doc_labelstringyes
invoices[].can_paybooleanyes
visitsarrayno
visits[].visit_idstring (uuid)yes
visits[].job_idstring (uuid)yes
visits[].summary['string', 'null']yes
visits[].title['string', 'null']yes
visits[].starts_atstring (date-time)yes
visits[].ends_atstring (date-time)yes
visits[].statusstringyes
visits[].can_ask_changebooleanyes
visits[].change['object', 'null']yes
requestsarrayno
requests[].request_idstring (uuid)yes
requests[].titlestringyes
requests[].stagestringyes
requests[].created_atstring (date-time)yes
plansarrayyes
plans[].plan_idstring (uuid)yes
plans[].namestringyes
plans[].term_monthsintegeryes
plans[].term_startstringyes
plans[].term_endstringyes
plans[].renews_on['string', 'null']yes
plans[].price_per_term_minorintegeryes
plans[].currencystringyes
plans[].coversarrayyes
plans[].visits_per_termintegeryes
plans[].next_visit['object', 'null']yes
plans[].visits_doneintegeryes
plans[].term_invoice_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
plans[].auto_sendbooleanyes
plans[].card['object', 'null']yes
{
  "state": "...",
  "plans": [
    {
      "plan_id": "00000000-0000-4000-8000-000000000000",
      "name": "Ruiz Plumbing",
      "term_months": 1,
      "term_start": "...",
      "term_end": "...",
      "renews_on": "...",
      "price_per_term_minor": 50000,
      "currency": "...",
      "covers": [
        "..."
      ],
      "visits_per_term": 1,
      "next_visit": "...",
      "visits_done": 1,
      "term_invoice_id": "00000000-0000-4000-8000-000000000000",
      "auto_send": true,
      "card": "..."
    }
  ]
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.