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.
When to use it
Keep checklist templates (checklists.saveTemplate) and put a checklist on a job or on one visit (checklists.create). Required items gate done: visits.done refuses a visit with open required items or a missing sign-off, and jobs.complete refuses a job while its own checklists, or those of visits not yet done, are open.
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
| Field | Type | Required |
|---|
job_id | string (uuid) | no |
visit_id | string (uuid) | no |
Example
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 |
{
"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. |