Skip to content

List Work Order Template Location Fields

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

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

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

Returns active workspace location definitions in fields, with id, name, and label. Names and labels are bounded to 200 characters. No customer values are returned. Results are ordered by case-insensitive name, then ID.

page defaults to 1 and pageSize to 25, maximum 100. Increment page while hasMore is true; page values above 1,000,000 are invalid.

Use a field ID as preferredLocationDataFieldId when creating a work-order template. For a populated value on a specific customer, use Prepare Work Order instead.

Generated Reference
POST /public-api/publicapi.v1.WorkOrderTemplate/ListWorkOrderTemplateLocationFields

Active location definitions, not customer location values.

Request ListWorkOrderTemplateLocationFieldsRequest
Response ListWorkOrderTemplateLocationFieldsResponse

ListWorkOrderTemplateLocationFieldsRequest

Field Type
page int32
page_size int32

ListWorkOrderTemplateLocationFieldsResponse

Field Type
fields repeated WorkOrderLocationField
page int32
page_size int32
has_more bool