Skip to content

List Work Order Templates

POST /public-api/publicapi.v1.WorkOrderTemplate/ListWorkOrderTemplates

Required scope: work_order_template:read. Requires content-template or settings read access, not settings write access.

{ "query": "Inspection", "page": 1, "pageSize": 25 }

Returns active workOrderTemplates with title, manual/advanced task counts, preferredLocation, and requiresLocationOverride. List responses do not include description or task bodies. query is optional, trimmed, and at most 200 characters: a literal case-insensitive substring of the title, not a regex or wildcard expression.

page defaults to 1 and pageSize to 25, maximum 100. Increment page while hasMore is true; page values above 1,000,000 are invalid. Results are ordered by case-insensitive title, then ID. This uses numbered pages, not RecordSearch cursors or problem-template afterId pagination.

An active preferred location definition does not prove that a particular customer has it populated. Use Prepare Work Order to choose a customer location and Get Work Order Template to inspect task detail.

Generated Reference
POST /public-api/publicapi.v1.WorkOrderTemplate/ListWorkOrderTemplates
Request ListWorkOrderTemplatesRequest
Response ListWorkOrderTemplatesResponse

ListWorkOrderTemplatesRequest

Field Type Description
page int32
page_size int32
query string Literal case-insensitive substring of the work-order title, not wildcard syntax.

ListWorkOrderTemplatesResponse

Field Type
work_order_templates repeated WorkOrderTemplate
page int32
page_size int32
has_more bool