checklists.list

Checklists on a job (all of them, job-level and per visit) or on one visit, with counts of open required items and sign-off state. Workers see the checklists of the jobs they can see.

WhoAgents can call this
RESTGET /v1/checklists
MCP toolchecklists_list
Writesno
AreaField work (checklists, forms, time, notes, change orders, subcontractors)

When to use it

Checklists on a job (all of them, job-level and per visit) or on one visit, with counts of open required items and sign-off state. Workers see the checklists of the jobs they can see.

What to tell the owner

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

Input

FieldTypeRequired
job_idstring (uuid)no
visit_idstring (uuid)no

Example

GET https://doingwork.work/v1/checklists?job_id=00000000-0000-4000-8000-000000000000&visit_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
dataarrayyes
data[].checklist_idstring (uuid)yes
data[].shop_idstring (uuid)yes
data[].job_idstring (uuid)yes
data[].visit_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
data[].checklist_template_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
data[].namestringyes
data[].signoff_requiredbooleanyes
data[].open_requiredintegeryes
data[].done_itemsintegeryes
data[].total_itemsintegeryes
data[].signature_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
data[].signoff_request_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
data[].locked['string', 'null']yes
data[].created_atstring (date-time)yes
{
  "data": [
    {
      "checklist_id": "00000000-0000-4000-8000-000000000000",
      "shop_id": "00000000-0000-4000-8000-000000000000",
      "job_id": "00000000-0000-4000-8000-000000000000",
      "visit_id": "00000000-0000-4000-8000-000000000000",
      "checklist_template_id": "00000000-0000-4000-8000-000000000000",
      "name": "Ruiz Plumbing",
      "signoff_required": true,
      "open_required": 1,
      "done_items": 1,
      "total_items": 1,
      "signature_id": "00000000-0000-4000-8000-000000000000",
      "signoff_request_id": "00000000-0000-4000-8000-000000000000",
      "locked": "...",
      "created_at": "..."
    }
  ]
}

Errors

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