Lists the tenant's work orders with cursor pagination (limit defaults to 20, maximum 100; pass next_cursor as after). Filters for order type, priority, status, service area, crew, account and connection combine with AND, and q searches the order text and also matches orders of accounts whose holder matches the search. Requires operations read access.
Parameters
limitinteger · query · optional
Maximum resources to return (default 20, maximum 100).
afterstring · query · optional
Opaque cursor returned by the previous page.
account_idstring · query · optional
Only orders raised for this account
connection_idstring · query · optional
Only orders raised for this connection
Returns
200Work orders
Show attributes
dataarray of WorkOrder · required
Show child attributes
idstring · optional
tenant_idstring · optional
order_numberstring · optional
order_typestring · optional
prioritystring · optional
statusstring · optional
account_idstring · optional
account_numberstring · optional
Number of the referenced account, e.g. CTA-000044. Omitted when unknown.
account_holder_namestring · optional
Display name of the customer who holds the referenced account. Omitted when unknown.
connection_idstring · optional
connection_holder_namestring · optional
Display name of the customer who holds the referenced connection. Omitted when unknown.
Create a field work order, with its material lines from a kit or one by one
Materials are planned when the order is created (RFC 0071 section 5.3). kit_id fills the lines from a kit (default picks the kit set for the order type); materials add catalogue items or free-text parts, or adjust a kit line (quantity 0 removes it). Meters are required lines by default on installation and replacement orders. Lines are reserved at the natural source (the crew's van, the service area's warehouse, the main warehouse); a shortage is a warning in the response, never a refusal. Without materials, proposed_kit_id offers the order type's default kit.
Body application/json
order_typestring · required
prioritystring · optional
asset_idstring · optional
service_area_idstring · optional
account_idstring · optional
crew_idstring · optional
descriptionstring · required
scheduled_atstring (date-time) · optional
connection_idstring · optional
required_skillstring · optional
kit_idstring · optional
A kit (kit_), or default for the order type's default kit
materialsarray of WorkOrderMaterialInput · optional
Show child attributes
item_idstring · optional
Catalogue item; omit for a free-text part
part_codestring · optional
descriptionstring · optional
quantitynumber · required
Quantity in the item's unit, with at most three decimals (12.5 metres).
unitstring · optional
requiredboolean · optional
Blocks dispatch until reserved; defaults to true for meters on installation and replacement orders
source_location_idstring · optional
Returns
201Work order created, with each material line's availability and reservation
Show attributes
idstring · required
tenant_idstring · required
order_numberstring · required
order_typestring · required
prioritystring · required
statusstring · required
crew_idstring · optional
service_area_idstring · optional
connection_idstring · optional
connection_holder_namestring · optional
Display name of the customer who holds the referenced connection. Omitted when unknown.
descriptionstring · required
created_atstring (date-time) · required
updated_atstring (date-time) · required
material_linesarray of WorkOrderMaterialLine · optional
Show child attributes
idstring · required
wml_ identifier (wmt_ for a legacy free-text material)
tenant_idstring · required
work_order_idstring · required
item_idstring · optional
item_codestring · optional
part_codestring · optional
descriptionstring · optional
unitstring · optional
plannednumber · required
Quantity in the item's unit, with at most three decimals (12.5 metres).
reservednumber · required
Quantity in the item's unit, with at most three decimals (12.5 metres).
issuednumber · required
Quantity in the item's unit, with at most three decimals (12.5 metres).
usednumber · optional
Quantity in the item's unit, with at most three decimals (12.5 metres).
returnednumber · required
Quantity in the item's unit, with at most three decimals (12.5 metres).
requiredboolean · required
source_location_idstring · optional
kit_idstring · optional
needs_mappingboolean · required
Free text for a stores person to map; touches no stock
legacyboolean · optional
stock_statusstring · required
one of reserved, partially_reserved, short, issued, settled, released, unmapped, untracked
serialisedboolean · optional
is_meterboolean · optional
cost_minorinteger (int64) · required
Issues less returns at average cost
availabilityobject · optional
Show child attributes
source_location_idstring · optional
source_location_namestring · optional
availablenumber · optional
Quantity in the item's unit, with at most three decimals (12.5 metres).
shortnumber · optional
Quantity in the item's unit, with at most three decimals (12.5 metres).
other_locationsarray of object · optional
Show child attributes
location_idstring · optional
location_namestring · optional
kindstring · optional
availablenumber · optional
Quantity in the item's unit, with at most three decimals (12.5 metres).
reservationsarray of object · optional
Show child attributes
idstring · optional
location_idstring · optional
quantitynumber · optional
Quantity in the item's unit, with at most three decimals (12.5 metres).
serial_idstring · optional
statusstring · optional
expires_atstring (date-time) · optional
created_atstring (date-time) · optional
suggested_transferobject · optional
Show child attributes
from_location_idstring · optional
to_location_idstring · optional
quantitynumber · optional
Quantity in the item's unit, with at most three decimals (12.5 metres).
created_bystring · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
material_cost_minorinteger (int64) · optional
Cost of the materials used, at average cost; per new connection on its installation order
proposed_kit_idstring · optional
Default kit for the order type, offered when created without materials
# No matching CLI command; use cURL or direct HTTP.
constres=awaitfetch("$BUSINESS_API/work-orders",{method:"POST",headers:{Authorization:"Bearer sk_test_...","Content-Type":"application/json"},body:JSON.stringify({"order_type":"order type","priority":"priority","asset_id":"ass_2IIXBYi79uuRV0QXd685rmSLhO0","service_area_id":"ser_23fmkpfkC17kSVJ2spjyiBbOED9","account_id":"act_2JFioNDgIfvkgflk8RtcqhBaARP","crew_id":"crw_2l1wOJtgejFoQBJcG9bsknLKyxp","description":"Leitura confirmada no local.","scheduled_at":"2026-11-19T09:30:00Z","connection_id":"con_2wuJTWy9FOCTPGA3noGbHegbLaU","required_skill":"required skill","kit_id":"kit_2uWTnksrliq19iiHpycNpyqZtmS","materials":[{"item_id":"itm_2vLmKDHWenXi6Pxs8hv8WJHGW53","part_code":"PAR-2026-000142","description":"Leitura confirmada no local.","quantity":1,"unit":"unit","required":true,"source_location_id":"sou_2nDQqZJueRPA8hXIWbBOkTVyEfd"}]})});constdata=awaitres.json();
importrequestsres=requests.post("$BUSINESS_API/work-orders",headers={"Authorization":"Bearer sk_test_..."},json={"order_type":"order type","priority":"priority","asset_id":"ass_2IIXBYi79uuRV0QXd685rmSLhO0","service_area_id":"ser_23fmkpfkC17kSVJ2spjyiBbOED9","account_id":"act_2JFioNDgIfvkgflk8RtcqhBaARP","crew_id":"crw_2l1wOJtgejFoQBJcG9bsknLKyxp","description":"Leitura confirmada no local.","scheduled_at":"2026-11-19T09:30:00Z","connection_id":"con_2wuJTWy9FOCTPGA3noGbHegbLaU","required_skill":"required skill","kit_id":"kit_2uWTnksrliq19iiHpycNpyqZtmS","materials":[{"item_id":"itm_2vLmKDHWenXi6Pxs8hv8WJHGW53","part_code":"PAR-2026-000142","description":"Leitura confirmada no local.","quantity":1,"unit":"unit","required":true,"source_location_id":"sou_2nDQqZJueRPA8hXIWbBOkTVyEfd"}]})data=res.json()
Get work order details, with material lines and material cost
Returns one work order with its status, crew, schedule, execution details and its material lines. Responds 404 when the order is not in the caller's tenant. Requires operations read access.
Parameters
idstring · path · required
ID of the work order in the caller's tenant.
Returns
200Work order details; material_lines and material_cost_minor appear when the order has materials
Show attributes
idstring · required
tenant_idstring · required
order_numberstring · required
order_typestring · required
prioritystring · required
statusstring · required
crew_idstring · optional
service_area_idstring · optional
connection_idstring · optional
connection_holder_namestring · optional
Display name of the customer who holds the referenced connection. Omitted when unknown.
descriptionstring · required
created_atstring (date-time) · required
updated_atstring (date-time) · required
material_linesarray of WorkOrderMaterialLine · optional
Show child attributes
idstring · required
wml_ identifier (wmt_ for a legacy free-text material)
tenant_idstring · required
work_order_idstring · required
item_idstring · optional
item_codestring · optional
part_codestring · optional
descriptionstring · optional
unitstring · optional
plannednumber · required
Quantity in the item's unit, with at most three decimals (12.5 metres).
reservednumber · required
Quantity in the item's unit, with at most three decimals (12.5 metres).
issuednumber · required
Quantity in the item's unit, with at most three decimals (12.5 metres).
usednumber · optional
Quantity in the item's unit, with at most three decimals (12.5 metres).
returnednumber · required
Quantity in the item's unit, with at most three decimals (12.5 metres).
requiredboolean · required
source_location_idstring · optional
kit_idstring · optional
needs_mappingboolean · required
Free text for a stores person to map; touches no stock
legacyboolean · optional
stock_statusstring · required
one of reserved, partially_reserved, short, issued, settled, released, unmapped, untracked
serialisedboolean · optional
is_meterboolean · optional
cost_minorinteger (int64) · required
Issues less returns at average cost
availabilityobject · optional
Show child attributes
source_location_idstring · optional
source_location_namestring · optional
availablenumber · optional
Quantity in the item's unit, with at most three decimals (12.5 metres).
shortnumber · optional
Quantity in the item's unit, with at most three decimals (12.5 metres).
other_locationsarray of object · optional
Show child attributes
location_idstring · optional
location_namestring · optional
kindstring · optional
availablenumber · optional
Quantity in the item's unit, with at most three decimals (12.5 metres).
reservationsarray of object · optional
Show child attributes
idstring · optional
location_idstring · optional
quantitynumber · optional
Quantity in the item's unit, with at most three decimals (12.5 metres).
serial_idstring · optional
statusstring · optional
expires_atstring (date-time) · optional
created_atstring (date-time) · optional
suggested_transferobject · optional
Show child attributes
from_location_idstring · optional
to_location_idstring · optional
quantitynumber · optional
Quantity in the item's unit, with at most three decimals (12.5 metres).
created_bystring · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
material_cost_minorinteger (int64) · optional
Cost of the materials used, at average cost; per new connection on its installation order
proposed_kit_idstring · optional
Default kit for the order type, offered when created without materials