Private preview of the new site. Not live.

visits.get

One visit with its job and workers.

WhoAgents can call this
RESTGET /v1/visits/get
MCP toolvisits_get
Writesno
AreaScheduling and visits

When to use it

Read schedule.settings first: it has the shop's time zone, working hours, arrival window and buffer. Use schedule.findTime to get open times that fit the shop's hours, each worker's hours and time off, and visits already booked with the buffer around them, then book with visits.create.

What to tell the owner

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

Input

FieldTypeRequired
visit_idstring (uuid)yes

Example

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

Output

FieldTypeAlways there
visit_idstring (uuid)yes
shop_idstring (uuid)yes
job_idstring (uuid)yes
job_summary['string', 'null']yes
starts_atstring (date-time)yes
ends_atstring (date-time)yes
title['string', 'null']yes
notes['string', 'null']yes
statusstringyes
cancel_reason['string', 'null']yes
series_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
started_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
done_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
done_note['string', 'null']yes
arrival_window_minutes['integer', 'null']yes
arrive_bystring (date-time)yes
on_the_way_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
eta_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
arrived_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
assignee_idsarrayyes
{
  "visit_id": "00000000-0000-4000-8000-000000000000",
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "job_id": "00000000-0000-4000-8000-000000000000",
  "job_summary": "...",
  "starts_at": "...",
  "ends_at": "...",
  "title": "...",
  "notes": "...",
  "status": "...",
  "cancel_reason": "...",
  "series_id": "00000000-0000-4000-8000-000000000000",
  "started_at": "...",
  "done_at": "...",
  "done_note": "...",
  "arrival_window_minutes": "...",
  "arrive_by": "...",
  "on_the_way_at": "...",
  "eta_at": "...",
  "arrived_at": "...",
  "assignee_ids": [
    "00000000-0000-4000-8000-000000000000"
  ]
}

Errors

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