jobs.brief

Everything already on a job, for a read before a visit or a proposal: notes (full text, paged), recordings and private truck notes (marked internal), photos and videos, this job's quotes and invoices, texts, calls (owner or office) and emails, other jobs at the same property, equipment, daily logs, open tasks, and similar past quotes. 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.

WhoAgents can call this
RESTGET /v1/jobs/brief
MCP tooljobs_brief
Writesno
AreaShop

When to use it

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.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
job_idstring (uuid)yes
visit_idstring (uuid)no
notes_cursorstringno
media_cursorstringno

Example

GET https://doingwork.work/v1/jobs/brief?job_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
jobobjectyes
job.job_idstring (uuid)yes
job.summary['string', 'null']yes
job.statusstringyes
job.customer_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
job.customer_name['string', 'null']yes
job.address['string', 'null']yes
visit['object', 'null']yes
notesarrayyes
notes[].note_idstring (uuid)yes
notes[].atstring (date-time)yes
notes[].sourcestringyes
notes[].channel['string', 'null']yes
notes[].pinnedbooleanyes
notes[].bodystringyes
notes_cursor['string', 'null']yes
mediaarrayyes
media[].media_idstring (uuid)yes
media[].kindstringyes
media[].stagestringyes
media[].provided_bystringyes
media[].channelstringyes
media[].summary['string', 'null']yes
media[].measurements['array', 'object', 'null']yes
media_cursor['string', 'null']yes
recordingsarrayyes
recordings[].recording_idstring (uuid)yes
recordings[].visit_idstring (uuid)yes
recordings[].described_as['string', 'null']yes
recordings[].clip_ref['string', 'null']yes
recordings[].transcript['string', 'null']yes
recordings[].worker_notes['object', 'null']yes
quotesarrayyes
quotes[].quote_idstring (uuid)yes
quotes[].statusstringyes
quotes[].historicalbooleanyes
quotes[].total_minor['integer', 'null']yes
invoicesarrayyes
invoices[].invoice_idstring (uuid)yes
invoices[].statusstringyes
invoices[].total_minor['integer', 'null']yes
messagesarrayyes
messages[].atstring (date-time)yes
messages[].directionstringyes
messages[].channelstringyes
messages[].customer_text['object', 'null']yes
messages[].shop_text['string', 'null']yes
callsarrayyes
calls[].atstring (date-time)yes
calls[].directionstringyes
calls[].duration_s['integer', 'null']yes
calls[].summary['string', 'null']yes
emailsarrayyes
emails[].atstring (date-time)yes
emails[].channelstringyes
emails[].kindstringyes
emails[].subjectstringyes
emails[].bodystringyes
other_jobsarrayyes
other_jobs[].job_idstring (uuid)yes
other_jobs[].summary['string', 'null']yes
other_jobs[].statusstringyes
equipmentarrayyes
equipment[].equipment_idstring (uuid)yes
equipment[].kindstringyes
equipment[].make['string', 'null']yes
equipment[].model['string', 'null']yes
equipment[].serial['string', 'null']yes
daily_logsarrayyes
daily_logs[].log_idstring (uuid)yes
daily_logs[].log_datestringyes
daily_logs[].bodystringyes
open_tasksarrayyes
open_tasks[].task_idstring (uuid)yes
open_tasks[].titlestringyes
open_tasks[].due_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
similar_quotesarrayyes
similar_quotes[].quote_idstring (uuid)yes
similar_quotes[].job_idstring (uuid)yes
similar_quotes[].statusstringyes
similar_quotes[].created_atstring (date-time)yes
similar_quotes[].job_summary['string', 'null']yes
similar_quotes[].customer_name['string', 'null']yes
similar_quotes[].total_minor['integer', 'null']yes
similar_quotes[].matchedarrayyes
similar_quotes[].linesarrayyes
similar_quotes[].lines[].descriptionstringyes
similar_quotes[].lines[].quantitynumberyes
similar_quotes[].lines[].unit_price_minor['integer', 'null']yes
next_actionsarrayyes
next_actions[].saystringyes
next_actions[].op['string', 'null']yes
next_actions[].whenstring (one of now, later, check, tell_human)yes
next_actions[].due_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']no
next_actions[].args_hintstringno
{
  "job": {
    "job_id": "00000000-0000-4000-8000-000000000000",
    "summary": "...",
    "status": "...",
    "customer_id": "00000000-0000-4000-8000-000000000000",
    "customer_name": "...",
    "address": "..."
  },
  "visit": "...",
  "notes": [
    {
      "note_id": "00000000-0000-4000-8000-000000000000",
      "at": "...",
      "source": "...",
      "channel": "...",
      "pinned": true,
      "body": "..."
    }
  ],
  "notes_cursor": "...",
  "media": [
    {
      "media_id": "00000000-0000-4000-8000-000000000000",
      "kind": "...",
      "stage": "...",
      "provided_by": "...",
      "channel": "...",
      "summary": "...",
      "measurements": "..."
    }
  ],
  "media_cursor": "...",
  "recordings": [
    {
      "recording_id": "00000000-0000-4000-8000-000000000000",
      "visit_id": "00000000-0000-4000-8000-000000000000",
      "described_as": "...",
      "clip_ref": "...",
      "transcript": "...",
      "worker_notes": "..."
    }
  ],
  "quotes": [
    {
      "quote_id": "00000000-0000-4000-8000-000000000000",
      "status": "...",
      "historical": true,
      "total_minor": "..."
    }
  ],
  "invoices": [
    {
      "invoice_id": "00000000-0000-4000-8000-000000000000",
      "status": "...",
      "total_minor": "..."
    }
  ],
  "messages": [
    {
      "at": "...",
      "direction": "...",
      "channel": "...",
      "customer_text": "...",
      "shop_text": "..."
    }
  ],
  "calls": [
    {
      "at": "...",
      "direction": "...",
      "duration_s": "...",
      "summary": "..."
    }
  ],
  "emails": [
    {
      "at": "...",
      "channel": "...",
      "kind": "...",
      "subject": "...",
      "body": "..."
    }
  ],
  "other_jobs": [
    {
      "job_id": "00000000-0000-4000-8000-000000000000",
      "summary": "...",
      "status": "..."
    }
  ],
  "equipment": [
    {
      "equipment_id": "00000000-0000-4000-8000-000000000000",
      "kind": "...",
      "make": "...",
      "model": "...",
      "serial": "..."
    }
  ],
  "daily_logs": [
    {
      "log_id": "00000000-0000-4000-8000-000000000000",
      "log_date": "...",
      "body": "..."
    }
  ],
  "open_tasks": [
    {
      "task_id": "00000000-0000-4000-8000-000000000000",
      "title": "...",
      "due_at": "..."
    }
  ],
  "similar_quotes": [
    {
      "quote_id": "00000000-0000-4000-8000-000000000000",
      "job_id": "00000000-0000-4000-8000-000000000000",
      "status": "...",
      "created_at": "...",
      "job_summary": "...",
      "customer_name": "...",
      "total_minor": "...",
      "matched": [
        "..."
      ],
      "lines": [
        {
          "description": "40 gallon gas heater, installed",
          "quantity": "...",
          "unit_price_minor": "..."
        }
      ]
    }
  ],
  "next_actions": [
    {
      "say": "...",
      "op": "...",
      "when": "now"
    }
  ]
}

Errors

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