visits.get
One visit with its job and workers.
| Who | Agents can call this |
| REST | GET /v1/visits/get |
| MCP tool | visits_get |
| Writes | no |
| Area | Scheduling and visits |
When to use it
One visit with its job and workers.
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
Input
| Field | Type | Required |
|---|---|---|
visit_id | string (uuid) | yes |
Example
GET https://doingwork.work/v1/visits/get?visit_id=00000000-0000-4000-8000-000000000000Output
| Field | Type | Always there |
|---|---|---|
visit_id | string (uuid) | yes |
shop_id | string (uuid) | yes |
job_id | string (uuid) | yes |
job_summary | ['string', 'null'] | yes |
starts_at | string (date-time) | yes |
ends_at | string (date-time) | yes |
title | ['string', 'null'] | yes |
notes | ['string', 'null'] | yes |
status | string (one of scheduled, on_the_way, arrived, started, done, cancelled) | yes |
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 |
priority | string | yes |
arrival_window_minutes | ['integer', 'null'] | yes |
arrive_by | string (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_ids | array | yes |
next_actions | array | yes |
next_actions[].say | string | yes |
next_actions[].op | ['string', 'null'] | yes |
next_actions[].when | string (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_hint | string | no |
{
"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": "scheduled",
"cancel_reason": "...",
"series_id": "00000000-0000-4000-8000-000000000000",
"started_at": "...",
"done_at": "...",
"done_note": "...",
"priority": "...",
"arrival_window_minutes": "...",
"arrive_by": "...",
"on_the_way_at": "...",
"eta_at": "...",
"arrived_at": "...",
"assignee_ids": [
"00000000-0000-4000-8000-000000000000"
],
"next_actions": [
{
"say": "...",
"op": "...",
"when": "now"
}
]
}Errors
| Code | Status | What to do |
|---|---|---|
invalid_input, invalid_token, rate_limited | Can happen on any call. See errors. |