Template

The template object repesents a public checklist template which can be customized by a user for his/her own use. When returning a list of templates, the actual groups/ tasks are not returned. If you require them, please request each template separately.

A template object contains the following fields:

A template is identical to a task/ checklist in structure. Please refer to the task object to view it's structure.

Sample Checklist Template XML

A template is identical to a task/ checklist in structure. Please refer to the task object to view it's structure.  

Supported methods

List (search)

Method list
Description Get a list of templates according to the specified filter
URL https://api.checklist.com/rest/v1/templates/list?language={language}&categories={category_id_1,category_id_2,category_id_3}&keywords={keywords}&start={start}&max={max} [GET]
Authentication required (commercial)
languageOptional. if not provided, the user's language will be used
categories(*)a comma separated list of category ids. Returned templates will match ALL these categories
Parameters keywords (*)keywords to match against template name
start | 0the template number to start at. Used for pagination. Default is 0 (start of list)
max | 10maximum number of templates to return. Default is 10.
Response A list of matching templates
Errors 401UnAuthorized - returned if not authorized to perform this action
Throttling This method is only allowed to commercial licenses

Get Template

Method get
Description Get a specific template
URL https://api.checklist.com/rest/v1/templates/{templateId} [GET]
Authentication required (commercial)
Parameters templateIdthe id of the template to be returned
Response The template object
Errors 401UnAuthorized - returned if not authorized to perform this action
404Not Found - returned if provided template id is invalid
Throttling This method is only allowed to commercial licenses

Customize Template

Method customize
Description Customize a template by duplicating the template into a checklist in the user's account.
URL https://api.checklist.com/account/{templateId}/customize [POST]
Authentication required (commercial)
Parameters templateIdthe template id
Response The checklist object
Errors 401UnAuthorized - returned if not authorized to perform this action
404Not Found - returned if provided template id is invalid
Throttling This method is only allowed to commercial licenses
* - optional parameter.   | x - x is the default value if none provided