jobs.get

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.

WhoAgents can call this
RESTGET /v1/jobs/get
MCP tooljobs_get
Writesno
AreaJobs (unlimited)

When to use it

Read one job with its address before working on it.

What to tell the owner

Here's the job.

Input

FieldTypeRequired
job_idstringyes

Example

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

Output

FieldTypeAlways there
job_idstring (uuid)yes
shop_idstring (uuid)yes
statusstringyes
kindstringyes
summary['string', 'null']yes
occurred_atstring (date-time)yes
customer_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
home_idstring (uuid)yes
request_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
address_line1stringyes
address_line2['string', 'null']yes
localitystringyes
postal_codestringyes
jurisdiction_idstringyes
nextstringyes
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_id": "00000000-0000-4000-8000-000000000000",
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "status": "...",
  "kind": "...",
  "summary": "...",
  "occurred_at": "...",
  "customer_id": "00000000-0000-4000-8000-000000000000",
  "home_id": "00000000-0000-4000-8000-000000000000",
  "request_id": "00000000-0000-4000-8000-000000000000",
  "address_line1": "...",
  "address_line2": "...",
  "locality": "Coeur d'Alene",
  "postal_code": "83814",
  "jurisdiction_id": "00000000-0000-4000-8000-000000000000",
  "next": "...",
  "next_actions": [
    {
      "say": "...",
      "op": "...",
      "when": "now"
    }
  ]
}

Errors

CodeStatusWhat to do
not_found404No such record, or this worker can't see it.
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.