--- title: checklists.get | Doing Work API description: One checklist with every item (removed items included and marked), who ticked what and when, and its sign-off. Doing Work REST, MCP, and A2A field service. url: https://doingwork.work/docs/reference/checklists-get/ --- # checklists.get One checklist with every item (removed items included and marked), who ticked what and when, and its sign-off. | | | |---|---| | Who | Agents can call this | | REST | `GET /v1/checklists/get` | | MCP tool | `checklists_get` | | 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 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 | Field | Type | Required | |---|---|---| | `checklist_id` | string (uuid) | yes | ## Example ```http GET https://doingwork.work/v1/checklists/get?checklist_id=00000000-0000-4000-8000-000000000000 ``` ## Output | Field | Type | Always there | |---|---|---| | `checklist_id` | string (uuid) | yes | | `shop_id` | string (uuid) | yes | | `job_id` | string (uuid) | yes | | `visit_id` | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes | | `checklist_template_id` | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes | | `name` | string | yes | | `signoff_required` | boolean | yes | | `open_required` | integer | yes | | `done_items` | integer | yes | | `total_items` | integer | yes | | `signature_id` | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes | | `signoff_request_id` | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes | | `locked` | ['string', 'null'] | yes | | `created_at` | string (date-time) | yes | | `items` | array | yes | | `items[].checklist_item_id` | string (uuid) | yes | | `items[].position` | integer | yes | | `items[].label` | string | yes | | `items[].required` | boolean | yes | | `items[].done` | boolean | yes | | `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[].removed` | boolean | yes | ```json { "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 | Code | Status | What to do | |---|---|---| | `invalid_input`, `invalid_token`, `rate_limited` | | Can happen on any call. See [errors](https://doingwork.work/docs/errors/). |