checklists.get

One checklist with every item (removed items included and marked), who ticked what and when, and its sign-off.

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

When to use it

One checklist with every item (removed items included and marked), who ticked what and when, and its sign-off.

What to tell the owner

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

Input

FieldTypeRequired
checklist_idstring (uuid)yes

Example

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

Output

FieldTypeAlways there
checklist_idstring (uuid)yes
shop_idstring (uuid)yes
job_idstring (uuid)yes
visit_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
checklist_template_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
namestringyes
signoff_requiredbooleanyes
open_requiredintegeryes
done_itemsintegeryes
total_itemsintegeryes
signature_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
signoff_request_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
locked['string', 'null']yes
created_atstring (date-time)yes
itemsarrayyes
items[].checklist_item_idstring (uuid)yes
items[].positionintegeryes
items[].labelstringyes
items[].requiredbooleanyes
items[].donebooleanyes
items[].done_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
items[].done_by['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
items[].note['string', 'null']yes
items[].removedbooleanyes
{
  "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": "...",
  "items": [
    {
      "checklist_item_id": "00000000-0000-4000-8000-000000000000",
      "position": 1,
      "label": "...",
      "required": true,
      "done": true,
      "done_at": "...",
      "done_by": "00000000-0000-4000-8000-000000000000",
      "note": "...",
      "removed": true
    }
  ]
}

Errors

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