--- title: checklists.list | Doing Work API description: 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. url: https://doingwork.work/docs/reference/checklists-list/ --- # 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. | | | |---|---| | Who | Agents can call this | | REST | `GET /v1/checklists` | | MCP tool | `checklists_list` | | Writes | no | | Area | [Field work (checklists, forms, time, notes, change orders, subcontractors)](https://doingwork.work/docs/reference/#field-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 | Field | Type | Required | |---|---|---| | `job_id` | string (uuid) | no | | `visit_id` | string (uuid) | no | ## Example ```http GET https://doingwork.work/v1/checklists?job_id=00000000-0000-4000-8000-000000000000&visit_id=00000000-0000-4000-8000-000000000000 ``` ## Output | Field | Type | Always there | |---|---|---| | `data` | array | yes | | `data[].checklist_id` | string (uuid) | yes | | `data[].shop_id` | string (uuid) | yes | | `data[].job_id` | string (uuid) | yes | | `data[].visit_id` | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes | | `data[].checklist_template_id` | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes | | `data[].name` | string | yes | | `data[].signoff_required` | boolean | yes | | `data[].open_required` | integer | yes | | `data[].done_items` | integer | yes | | `data[].total_items` | integer | yes | | `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_at` | string (date-time) | yes | ```json { "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 | Code | Status | What to do | |---|---|---| | `invalid_input`, `invalid_token`, `rate_limited` | | Can happen on any call. See [errors](https://doingwork.work/docs/errors/). |