visits.steps

The guided visit steps for a visit, each done, skipped, or open, and the next one to suggest. Walk the worker through them in conversation; they are loose, and any step can be skipped.

WhoAgents can call this
RESTGET /v1/visits/steps
MCP toolvisits_steps
Writesno
AreaScheduling and visits

When to use it

The guided visit steps for a visit, each done, skipped, or open, and the next one to suggest. Walk the worker through them in conversation; they are loose, and any step can be skipped.

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/steps?visit_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
visit_idstring (uuid)yes
time_zonestringyes
summarystringyes
displayobjectyes
display.kindstring (one of table, cards, timeline, checklist, map, calendar, chart)yes
display.titlestringyes
display.columnsarrayno
display.columns[].keystringyes
display.columns[].labelstringyes
display.fieldsarrayno
display.fields[].keystringyes
display.fields[].labelstringyes
stepsarrayyes
steps[].keystringyes
steps[].labelstringyes
steps[].op['string', 'null']yes
steps[].statestringyes
steps[].note['string', 'null']yes
steps[].marked_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
next_step['object', '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
{
  "visit_id": "00000000-0000-4000-8000-000000000000",
  "time_zone": "...",
  "summary": "...",
  "display": {
    "kind": "table",
    "title": "..."
  },
  "steps": [
    {
      "key": "...",
      "label": "...",
      "op": "...",
      "state": "...",
      "note": "...",
      "marked_at": "..."
    }
  ],
  "next_step": "...",
  "next_actions": [
    {
      "say": "...",
      "op": "...",
      "when": "now"
    }
  ]
}

Errors

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