checklists.listTemplates
The shop's checklist templates with their items. Archived ones only with include_archived.
When to use it
The shop's checklist templates with their items. Archived ones only with include_archived.
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
| Field | Type | Required |
|---|
shop_id | string (uuid) | yes |
include_archived | boolean | no |
Example
GET https://doingwork.work/v1/checklist-templates?shop_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
data | array | yes |
data[].checklist_template_id | string (uuid) | yes |
data[].shop_id | string (uuid) | yes |
data[].name | string | yes |
data[].description | ['string', 'null'] | yes |
data[].signoff_required | boolean | yes |
data[].archived_at | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes |
data[].updated_at | string (date-time) | yes |
data[].items | array | yes |
data[].items[].position | integer | yes |
data[].items[].label | string | yes |
data[].items[].required | boolean | yes |
{
"data": [
{
"checklist_template_id": "00000000-0000-4000-8000-000000000000",
"shop_id": "00000000-0000-4000-8000-000000000000",
"name": "Ruiz Plumbing",
"description": "40 gallon gas heater, installed",
"signoff_required": true,
"archived_at": "...",
"updated_at": "...",
"items": [
{
"position": 1,
"label": "...",
"required": true
}
]
}
]
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |