> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/product/features/checklists/checklist-templates.md).

# Checklist templates

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). [Source on GitHub](https://github.com/snapfix/docs/blob/main/product/features/checklist-templates.md).
{% endhint %}

Admins keep reusable checklists as **checklist templates**, filed in **folders**, for one **site** or for a whole **multi-site**, and put them on **tasks** and **planned tasks** instead of building each checklist again. A **library** of ready-made templates is shared by every site. Any checklist made on a task can be saved as a template. Templates can be copied, moved, put on or replaced on many tasks at once, and taken off tasks. Each template keeps an **audit trail** of its changes. Templates are managed on the web, in the Site Console and the Multi-Site Console; the apps pick a template for a task and fill in the checklist it becomes ([Checklists](https://docs.snapfix.com/product/features/checklists/checklists.md)).

## Rules

### Templates and folders

* A template belongs to one site or one multi-site, and sits in one or more of its folders. It has a name of up to 255 characters, an optional description and note, a "Require Signature" setting, and one checklist of sections and items ([Checklist template object](https://docs.snapfix.com/engineering-reference/api/checklists.md#checklist-template-object), [POST /v1/app/checklists/{scope}/templates](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopetemplates)).
* Templates are managed by the site role, not by the site permission "manage checklist": the Site Console's "Checklists" tab gives every action to role "Admin", and the API checks that the caller administers the site \[[ASK-131](https://github.com/snapfix/docs/blob/main/ASK.md#ask-131-should-the-create--edit--delete-checklists-permission-let-users-manage-checklist-templates)]. Group admins also reach the page by URL; they see the folder list without buttons, but each template still has its menu. In the Multi-Site Console every multi-site user gets the whole page \[[ASK-123](https://github.com/snapfix/docs/blob/main/ASK.md#ask-123-who-may-manage-a-multi-site-and-change-its-members-site-roles)] ([Console: checklists](https://docs.snapfix.com/how-the-apps-work/screens/console/checklists.md)).
* A user who belongs to several multi-sites manages only the first one: the multi-site routes compare the template's multi-site with the caller's first multi-site ([Checklist access checks](https://docs.snapfix.com/engineering-reference/api/checklists.md#checklist-access-checks)).
* Deleting a folder takes it off each of its templates, and a template left in no folder is deleted too, by design. The dialog warns "Deleting this Checklist folder will permanently remove all its Checklists from its Tasks." ([DELETE /v1/app/checklists/{scope}/folders/{uuid}](https://docs.snapfix.com/engineering-reference/api/checklists.md#delete-v1appchecklistsscopefoldersuuid)).
* Deleting a template marks it deleted. Its checklist, items and task links stay in the database. Tasks that started the checklist keep their own items; tasks that never started it lose it, because the deleted template no longer reads ([DELETE /v1/app/checklists/{scope}/templates/{templateUuid}](https://docs.snapfix.com/engineering-reference/api/checklists.md#delete-v1appchecklistsscopetemplatestemplateuuid)).

### Who can use a template

* A multi-site template can be switched on or off for each site of the multi-site, and any template for each group. A site or group with no setting counts as on ([Checklist permission object](https://docs.snapfix.com/engineering-reference/api/checklists.md#checklist-permission-object)).
* Admins switch groups one by one or all at once in the Groups tab, and sites in the Sites tab (Multi-Site Console) ([Console: checklists](https://docs.snapfix.com/how-the-apps-work/screens/console/checklists.md#actions)). The site's Groups tab and its all-groups switch cover only the admin's own groups of the site \[[ASK-139](https://github.com/snapfix/docs/blob/main/ASK.md#ask-139-should-a-site-templates-group-settings-cover-only-the-admins-own-groups)].
* The pickers on a task list only the templates switched on for the task's group ([GET /v1/app/checklists/site/templates/group/{groupUuid}/list-by-folder/{folderUuid}](https://docs.snapfix.com/engineering-reference/api/checklists.md#get-v1appchecklistssitetemplatesgroupgroupuuidlist-by-folderfolderuuid)).

### Putting templates on tasks

* Putting a template on a task deletes the task's own items and links the template. The task then shows the template's items until its checklist is started, and it takes the template's "Require Signature" setting ([POST /v1/app/checklists/{scope}/jobs](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopejobs)). Each changed task sends its people a silent update.
* One request takes at most 5,000 tasks (`CHECKLIST_SELECT_ALL_LIMIT`). Putting a template on every task of a group that matches the task list's filters has no limit. When no task matches, it answers with an error, not a count ([POST /v1/app/checklists/{scope}/jobs/all](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopejobsall)).
* The Site Console's "Assign to Tasks", "Replace Checklist" and "Remove from Tasks" pick from tasks whose checklist hasn't been started, so they never change a started checklist. "Replace Checklist" first takes the old template off, then puts the new one on ([Console: checklists](https://docs.snapfix.com/how-the-apps-work/screens/console/checklists.md#actions), api\_php\_live\_v2 @ ef3c4319f6, `app/Services/AssetJobService.php:1544-1547`).
* Taking a template off tasks removes only the link; the tasks' own items stay ([POST /v1/app/checklists/{scope}/jobs/delete](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopejobsdelete)). On a single task, "Remove From Task" also deletes the items of a started checklist ([Checklist](https://docs.snapfix.com/how-the-apps-work/screens/checklists/checklist.md#actions)).
* The site and the tasks are not checked against the caller when a site template is put on or taken off tasks.
* A template put on a planned task goes onto each task the planned task creates from then on; tasks already created don't change ([POST /v1/app/checklists/{scope}/schedules](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopeschedules)).

### Changing templates

* Editing a template changes its items. Tasks that haven't started the checklist show the change at once; started checklists keep their own copy ([PUT /v1/app/checklists/{scope}/templates/{templateUuid}](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1appchecklistsscopetemplatestemplateuuid), [Checklists](https://docs.snapfix.com/product/features/checklists/checklists.md#editing-removing-and-clearing)).
* "Make a Copy" makes a new template with its own copy of the items, in the folder chosen: in the same site or multi-site, or across between a site and its multi-site. Task links and group switches are not copied ([POST /v1/app/checklists/{scope}/templates/copy](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopetemplatescopy)).
* "Move from folder" makes the template again in the target folder on the same checklist, moves the tasks' links and the switches to it, and deletes the old template. The tasks keep their items ([POST /v1/app/checklists/{scope}/templates/move](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopetemplatesmove)).
* Copy and move skip the templates the caller may not manage, without an error \[[ASK-70](https://github.com/snapfix/docs/blob/main/ASK.md#ask-70-should-a-copy-or-move-that-skips-templates-say-so)], and don't check the target folder's site.
* "Set as template" (site admins, on a task whose checklist is not from a template) saves the task's checklist as a new site template, then puts that template on the task ([Checklist](https://docs.snapfix.com/how-the-apps-work/screens/checklists/checklist.md#actions)). iOS offers it to site admins too; Android to account admins, not for planned tasks ([Checklist menu](https://docs.snapfix.com/how-the-apps-work/screens/checklists/checklist.md#checklist-menu)).

### Library and multi-site templates

* The library is the same for every site, and any signed-in user can list it. A download makes a copy in a folder, so the library template doesn't change. A download is refused when a template of the same site or multi-site already has that name: "This checklist has already been downloaded. Please use another ’Checklist name’ to download another copy." ([POST /v1/app/checklists/{scope}/templates/download](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopetemplatesdownload)).
* A site that belongs to a multi-site gets "Pick from templates" instead of the library: it copies the multi-site's templates into a folder of the site, with no name check ([POST /v1/app/checklists/site/templates/download/multiSite](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistssitetemplatesdownloadmultisite)).

### Audit trail

* Creating, changing, copying, moving, downloading and deleting a template each write a line with the person and the time; the Site Console shows them as "Audit Trail". Folder changes and group or site switches are not logged ([Checklist activity object](https://docs.snapfix.com/engineering-reference/api/checklists.md#checklist-activity-object)).
* Any signed-in user can read any template, and its audit trail, by its UUID.

## Flow

```mermaid
flowchart LR
  lib["Snapfix library"] -- "download, as a copy" --> tpl["Template in a folder"]
  multi["Multi-site template"] -- "Pick from templates" --> tpl
  task["Checklist made on a task"] -- "Set as template" --> tpl
  tpl --> enable["On or off for each group (and site)"]
  enable --> assign["Put on tasks or planned tasks"]
  assign --> fill["Tasks show the template's items until started"]
  tpl -- "edit" --> fill
  tpl -- "copy" --> copy["New template with its own items"]
  tpl -- "move" --> moved["Template in the target folder, old one deleted"]
  tpl -- "delete" --> gone["Started tasks keep their items"]
```

## Platforms

| Capability                                       | Web                                                         | iOS                                                                                                                      | Android                              |
| ------------------------------------------------ | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ |
| Folders, templates, copy, move, delete           | Site Console and Multi-Site Console                         | No                                                                                                                       | No                                   |
| Library and "Pick from templates"                | Yes                                                         | No                                                                                                                       | No                                   |
| Switch a template on or off for groups and sites | Yes                                                         | No                                                                                                                       | No                                   |
| Audit trail                                      | Yes                                                         | No                                                                                                                       | No                                   |
| Edit a template                                  | Yes                                                         | Yes, from a template ([Edit checklist](https://docs.snapfix.com/how-the-apps-work/screens/checklists/edit-checklist.md)) | Yes, from a template                 |
| Put a template on one task                       | The card's "+"                                              | "Add Checklist"                                                                                                          | "Add Checklist"                      |
| Put a template on many tasks                     | Console "Assign to Tasks", and the task list's bulk actions | Multi-select                                                                                                             | Multi-select                         |
| Save a task's checklist as a template            | Site admins                                                 | Site admins                                                                                                              | Account admins, not on planned tasks |
| Templates on planned tasks                       | Yes                                                         | Yes                                                                                                                      | Yes                                  |

The apps keep a copy of their sites' templates, read after sign-in and when the user switches site ([read\_parent\_checklist\_data](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-actionread_parent_checklist_data)). Adding a checklist to many tasks in the apps needs "manage checklist" ([Multi-select](https://docs.snapfix.com/product/features/tasks/multi-select.md); ios @ aa31967ac8, `SnapFix/HomeVC+SelectAlll.swift:312-315`).

## Screens

* [Console: checklists](https://docs.snapfix.com/how-the-apps-work/screens/console/checklists.md): folders, templates, the library, copy, move, group and site switches, assigning, replacing and removing, and the audit trail.
* [Edit checklist](https://docs.snapfix.com/how-the-apps-work/screens/checklists/edit-checklist.md): the template editor, and "Create a template".
* [Checklist](https://docs.snapfix.com/how-the-apps-work/screens/checklists/checklist.md): adding a template to a task, "Set as template" and "Remove From Task".
* [Task detail](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md) and [Create planned task](https://docs.snapfix.com/how-the-apps-work/screens/planner/planned-task.md): where a template is put on a task or planned task.

## API and data

* [Checklists API](https://docs.snapfix.com/engineering-reference/api/checklists.md):
  * Templates: [create](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopetemplates), [read](https://docs.snapfix.com/engineering-reference/api/checklists.md#get-v1appchecklistsscopetemplatesuuid), [list by folder](https://docs.snapfix.com/engineering-reference/api/checklists.md#get-v1appchecklistsscopetemplateslist-by-folderfolderuuid), [change](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1appchecklistsscopetemplatestemplateuuid), [delete](https://docs.snapfix.com/engineering-reference/api/checklists.md#delete-v1appchecklistsscopetemplatestemplateuuid), [copy](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopetemplatescopy) and [move](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopetemplatesmove).
  * Folders: [list](https://docs.snapfix.com/engineering-reference/api/checklists.md#get-v1appchecklistsscopefolders), [create](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopefolders), [change](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1appchecklistsscopefoldersuuid) and [delete](https://docs.snapfix.com/engineering-reference/api/checklists.md#delete-v1appchecklistsscopefoldersuuid).
  * Library: [list](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistslibrary), [one checklist](https://docs.snapfix.com/engineering-reference/api/checklists.md#get-v1appchecklistslibraryuuid), [tags](https://docs.snapfix.com/engineering-reference/api/checklists.md#get-v1appcheckliststags), [download](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopetemplatesdownload); from a multi-site: [download](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistssitetemplatesdownloadmultisite).
  * Switches: [a site template for a group](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1appchecklistssitepermissionsgroup) and [for all groups](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1appchecklistssitepermissionsgroupall); [a multi-site template for a site](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1appchecklistsmultisitepermissionsparent), [for all sites](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1appchecklistsmultisitepermissionsparentall), [for a group](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1appchecklistsmultisitepermissionsgroup) and [for all groups](https://docs.snapfix.com/engineering-reference/api/checklists.md#put-v1appchecklistsmultisitepermissionsgroupall).
  * Tasks and planned tasks: [put on tasks](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopejobs), [put on matching tasks](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopejobsall), [take off tasks](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopejobsdelete), [a group's tasks with a template](https://docs.snapfix.com/engineering-reference/api/checklists.md#get-v1appchecklistsscopejobstemplateuuidgroupbusinessuuid), [put on planned tasks](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopeschedules) and [take off planned tasks](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-v1appchecklistsscopeschedulesdelete).
  * Audit trail: [GET /v1/app/checklists/{entityUuid}/activities](https://docs.snapfix.com/engineering-reference/api/checklists.md#get-v1appchecklistsentityuuidactivities).
  * The apps' sync of templates: [save\_cl\_site\_template](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-actionsave_cl_site_template), [save\_cl\_item](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-actionsave_cl_item) and [save\_job\_cl\_template](https://docs.snapfix.com/engineering-reference/api/checklists.md#post-actionsave_job_cl_template).
* [Tasks API](https://docs.snapfix.com/engineering-reference/api/tasks.md): the Console's task picker, [POST /v1/app/tasks/list-for-checklist](https://docs.snapfix.com/engineering-reference/api/tasks.md#post-v1apptaskslist-for-checklist).
* Tables: [`tPri_CL_SiteTemplate`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_cl_sitetemplate.md) and [`tPri_CL_MultiSiteTemplate`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_cl_multisitetemplate.md) (templates), [`tPri_CL`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_cl.md), [`tPri_CL_Item`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_cl_item.md) and [`tPri_CL_Item_Notes`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_cl_item_notes.md) (their checklists and items), [`tPri_CL_SiteTemplateVirtualFolders`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_cl_sitetemplatevirtualfolders.md) and [`tPri_CL_MultiSiteTemplateVirtualFolders`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_cl_multisitetemplatevirtualfolders.md) (folders), [`tPri_CL_Permissions`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_cl_permissions.md), [`tPri_CL_SiteTemplatePermissions`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_cl_sitetemplatepermissions.md) and [`tPri_CL_MultiSiteTemplatePermissions`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_cl_multisitetemplatepermissions.md) (switches), [`tPri_CL_Library`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_cl_library.md) (the library), [`tPri_Job_CL_Template`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_job_cl_template.md) (task links), [`schedule_v3`](https://docs.snapfix.com/engineering-reference/db/tables/schedule_v3.md) (planned tasks) and [`tPri_ChecklistLog`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_checklistlog.md) (the audit trail).

## Depends on

* [Checklists](https://docs.snapfix.com/product/features/checklists/checklists.md): what a template becomes on a task, and when the task keeps its own copy.
* [Planned tasks](https://docs.snapfix.com/product/features/planner/planned-tasks.md): templates on planned tasks.
* [Multi-Site Console](https://docs.snapfix.com/product/features/console/multi-site-console.md): multi-site templates and the sites that can use them.
* [Groups](https://docs.snapfix.com/product/features/groups/groups.md): the groups a template is switched on for.
* [Site users](https://docs.snapfix.com/product/features/console/site-users.md): who is a site admin.
* [Multi-select](https://docs.snapfix.com/product/features/tasks/multi-select.md): adding a checklist to many tasks from a task list.
* [Asset tasks](https://docs.snapfix.com/product/features/assets/asset-tasks.md): templates on assets and their tasks.
* [Push notifications](https://docs.snapfix.com/product/features/notifications/push-notifications.md): the silent update each changed task sends.

## Edge cases

* **Template edited after assignment:** tasks that haven't started the checklist follow the change; started ones don't.
* **Template or folder deleted:** see [Templates and folders](#templates-and-folders).
* **No matching tasks:** putting a template on all matching tasks answers with an error.
* **Several multi-sites:** only the first multi-site is managed.
* **Name clash:** a library download with a name already used in the site or multi-site is refused; "Pick from templates" makes duplicates without a check.
* **Library folders:** the library's own folder routes check nothing beyond the sign-in, and no client calls them.
* **Offline (apps):** the apps pick from their device copy of the templates; managing templates needs the web.
* **Time zones and integrations:** none for templates.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/product/features/checklists/checklist-templates.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
