| X-Entity-Id required | integer https://app.clickmaint.ca/api/v1/parts/{id}/reconcile Request samples Content typeapplication/json Response samples Content typeapplication/json {"status": "success", "data": {"id": 102, "name": "Air Filter", "description": "Fiberglass panel filter", "is_non_stock": false, "number": "FL_A", "area": "Filters bin", "lead_time": 7, "on_hand_qty": 6, "min_qty": 5, "desired_qty": 8, "unit_cost": 26.15, "avg_unit_cost": 26.15, "part_type": {"id": 3, "name": "Filters"
}, "storeroom": {"id": 1, "name": "Main Warehouse"
}, "measurement_unit": {"id": 2, "name": "Item", "short_name": "itm"
}, "available": 5, "reserved": 1, "assets": [{"id": 51, "name": "Air Purifier 1"
}, {"id": 52, "name": "Air Purifier 2"
}
], "qr_code": "guVT5ngMeZ9xPBIk8db4dCGXVU", "images": [{"id": 5, "url": "/api/v1/store/attachments/image/5/upload/d9a6433a7e8acdfaa8dce1f339172449.jpg", "download_url": "../dictionary", "size": 2017802, "type": "image/jpeg", "name": "conference-room-photo.jpg", "attachment_urls": {"small": "/api/v1/store/attachments/image/5/upload/small-f3687c1c901ce528370aac370f888ed3.jpg", "medium": "/api/v1/store/attachments/image/5/upload/medium-f0dfda3ad1ea6b708d46adbf57d6bed1.jpg", "large": "/api/v1/store/attachments/image/5/upload/large-1b4dc08567e1df9f550b5c75a174f915.jpg"
}
}
], "documents": [{"id": 6, "url": "/api/v1/store/attachments/document/6/upload/45bcc85b9513c2c4302b468c4694ae16.pdf", "download_url": "../dictionary", "size": 39777, "type": "application/pdf", "name": "asset-manual.pdf"
}
], "created_at": "2025-07-17T19:19:20Z", "updated_at": "2025-09-24T14:20:25Z", "created_by": {"id": 1, "name": "John", "surname": "Doe"
}, "updated_by": {"id": 2, "name": "Alice", "surname": "Johnson"
}
},
}Update part unit cost Request Body schema: application/json| cost required | number decimal places <= 2 >= 0 Sets the new unit_cost for the Part by creating a cost_update transaction.
| | note | | | object Upload files (images and documents). Keys must be numeric strings.
- Image size limit - 150MB
- Document size limit - 100MB
|
US based Click Maint API server
https://app.clickmaint.com/api/v1/parts/{id}/unit_cost Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/parts/{id}/unit_cost Request samples Content typeapplication/json Response samples Content typeapplication/json {"status": "success", "data": {"id": 102, "name": "Air Filter", "description": "Fiberglass panel filter", "is_non_stock": false, "number": "FL_A", "area": "Filters bin", "lead_time": 7, "on_hand_qty": 6, "min_qty": 5, "desired_qty": 8, "unit_cost": 26.15, "avg_unit_cost": 26.15, "part_type": {"id": 3, "name": "Filters"
}, "storeroom": {"id": 1, "name": "Main Warehouse"
}, "measurement_unit": {"id": 2, "name": "Item", "short_name": "itm"
}, "available": 5, "reserved": 1, "assets": [{"id": 51, "name": "Air Purifier 1"
}, {"id": 52, "name": "Air Purifier 2"
}
], "qr_code": "guVT5ngMeZ9xPBIk8db4dCGXVU", "images": [{"id": 5, "url": "/api/v1/store/attachments/image/5/upload/d9a6433a7e8acdfaa8dce1f339172449.jpg", "download_url": "../dictionary", "size": 2017802, "type": "image/jpeg", "name": "conference-room-photo.jpg", "attachment_urls": {"small": "/api/v1/store/attachments/image/5/upload/small-f3687c1c901ce528370aac370f888ed3.jpg", "medium": "/api/v1/store/attachments/image/5/upload/medium-f0dfda3ad1ea6b708d46adbf57d6bed1.jpg", "large": "/api/v1/store/attachments/image/5/upload/large-1b4dc08567e1df9f550b5c75a174f915.jpg"
}
}
], "documents": [{"id": 6, "url": "/api/v1/store/attachments/document/6/upload/45bcc85b9513c2c4302b468c4694ae16.pdf", "download_url": "../dictionary", "size": 39777, "type": "application/pdf", "name": "asset-manual.pdf"
}
], "created_at": "2025-07-17T19:19:20Z", "updated_at": "2025-09-24T14:20:25Z", "created_by": {"id": 1, "name": "John", "surname": "Doe"
}, "updated_by": {"id": 2, "name": "Alice", "surname": "Johnson"
}
},
}Update part average unit cost Request Body schema: application/json| cost required | number decimal places <= 2 >= 0 Sets the new avg_unit_cost for the Part by creating an average_cost_update transaction.
| | note | | | object Upload files (images and documents). Keys must be numeric strings.
- Image size limit - 150MB
- Document size limit - 100MB
|
US based Click Maint API server
https://app.clickmaint.com/api/v1/parts/{id}/average_unit_cost Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/parts/{id}/average_unit_cost Request samples Content typeapplication/json Response samples Content typeapplication/json {"status": "success", "data": {"id": 102, "name": "Air Filter", "description": "Fiberglass panel filter", "is_non_stock": false, "number": "FL_A", "area": "Filters bin", "lead_time": 7, "on_hand_qty": 6, "min_qty": 5, "desired_qty": 8, "unit_cost": 26.15, "avg_unit_cost": 26.15, "part_type": {"id": 3, "name": "Filters"
}, "storeroom": {"id": 1, "name": "Main Warehouse"
}, "measurement_unit": {"id": 2, "name": "Item", "short_name": "itm"
}, "available": 5, "reserved": 1, "assets": [{"id": 51, "name": "Air Purifier 1"
}, {"id": 52, "name": "Air Purifier 2"
}
], "qr_code": "guVT5ngMeZ9xPBIk8db4dCGXVU", "images": [{"id": 5, "url": "/api/v1/store/attachments/image/5/upload/d9a6433a7e8acdfaa8dce1f339172449.jpg", "download_url": "../dictionary", "size": 2017802, "type": "image/jpeg", "name": "conference-room-photo.jpg", "attachment_urls": {"small": "/api/v1/store/attachments/image/5/upload/small-f3687c1c901ce528370aac370f888ed3.jpg", "medium": "/api/v1/store/attachments/image/5/upload/medium-f0dfda3ad1ea6b708d46adbf57d6bed1.jpg", "large": "/api/v1/store/attachments/image/5/upload/large-1b4dc08567e1df9f550b5c75a174f915.jpg"
}
}
], "documents": [{"id": 6, "url": "/api/v1/store/attachments/document/6/upload/45bcc85b9513c2c4302b468c4694ae16.pdf", "download_url": "../dictionary", "size": 39777, "type": "application/pdf", "name": "asset-manual.pdf"
}
], "created_at": "2025-07-17T19:19:20Z", "updated_at": "2025-09-24T14:20:25Z", "created_by": {"id": 1, "name": "John", "surname": "Doe"
}, "updated_by": {"id": 2, "name": "Alice", "surname": "Johnson"
}
},
}List part transaction history query Parameters| search | | | sort | string Example: sort=created_at desc Sort by field ascending or descending
| | object Example: filter[note_cont]=invoice Filter using filter[field_matcher] syntax
| | page | | | per_page | |
US based Click Maint API server
https://app.clickmaint.com/api/v1/parts/{id}/transaction_history Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/parts/{id}/transaction_history Response samples Content typeapplication/json {"status": "success", "data": [{"id": 102, "note": "Purchase order PO-12345 received", "type": "restock", "work_order_id": null, "cost": 26.15, "total_cost": 52.3, "quantity": 2, "images": [{"id": 5, "url": "/api/v1/store/attachments/image/5/upload/d9a6433a7e8acdfaa8dce1f339172449.jpg", "download_url": "../dictionary", "size": 2017802, "type": "image/jpeg", "name": "conference-room-photo.jpg", "attachment_urls": {"small": "/api/v1/store/attachments/image/5/upload/small-f3687c1c901ce528370aac370f888ed3.jpg", "medium": "/api/v1/store/attachments/image/5/upload/medium-f0dfda3ad1ea6b708d46adbf57d6bed1.jpg", "large": "/api/v1/store/attachments/image/5/upload/large-1b4dc08567e1df9f550b5c75a174f915.jpg"
}
}
], "documents": [{"id": 6, "url": "/api/v1/store/attachments/document/6/upload/45bcc85b9513c2c4302b468c4694ae16.pdf", "download_url": "../dictionary", "size": 39777, "type": "application/pdf", "name": "asset-manual.pdf"
}
], "created_at": "2025-07-17T19:19:20Z", "updated_at": "2025-09-24T14:20:25Z", "created_by": {"id": 1, "name": "John", "surname": "Doe"
}, "updated_by": {"id": 2, "name": "Alice", "surname": "Johnson"
}
}
], "meta": {"pagination": {"total": 50, "page": 1, "per_page": 25, "total_pages": 2
}, "search": "Building A", "total_used": 8.5
}
}Get part transaction path Parameters| id required | | | transaction_id required | |
US based Click Maint API server
https://app.clickmaint.com/api/v1/parts/{id}/transaction/{transaction_id} Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/parts/{id}/transaction/{transaction_id} Response samples Content typeapplication/json {"status": "success", "data": {"id": 102, "note": "Purchase order PO-12345 received", "type": "restock", "work_order_id": null, "cost": 26.15, "total_cost": 52.3, "quantity": 2, "images": [{"id": 5, "url": "/api/v1/store/attachments/image/5/upload/d9a6433a7e8acdfaa8dce1f339172449.jpg", "download_url": "../dictionary", "size": 2017802, "type": "image/jpeg", "name": "conference-room-photo.jpg", "attachment_urls": {"small": "/api/v1/store/attachments/image/5/upload/small-f3687c1c901ce528370aac370f888ed3.jpg", "medium": "/api/v1/store/attachments/image/5/upload/medium-f0dfda3ad1ea6b708d46adbf57d6bed1.jpg", "large": "/api/v1/store/attachments/image/5/upload/large-1b4dc08567e1df9f550b5c75a174f915.jpg"
}
}
], "documents": [{"id": 6, "url": "/api/v1/store/attachments/document/6/upload/45bcc85b9513c2c4302b468c4694ae16.pdf", "download_url": "../dictionary", "size": 39777, "type": "application/pdf", "name": "asset-manual.pdf"
}
], "created_at": "2025-07-17T19:19:20Z", "updated_at": "2025-09-24T14:20:25Z", "created_by": {"id": 1, "name": "John", "surname": "Doe"
}, "updated_by": {"id": 2, "name": "Alice", "surname": "Johnson"
}
},
}Create new request Request Body schema: application/jsonrequired | |
US based Click Maint API server
https://app.clickmaint.com/api/v1/requests Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/requests Request samples Content typeapplication/json {"work_order_request": {"title": "Fix water leakage in Freezer", "description": "Water leakage due to blocked defrost drain", "status": "on_hold", "notify": true, "priority": "high", "location_id": 122, "asset_id": 45, "due_date": "2025-07-17T12:00:00Z",
}
} Response samples Content typeapplication/json {"status": "success", "data": {"id": 1126, "title": "Fix water leakage in Freezer", "description": "Water leakage due to blocked defrost drain", "status": "on_hold", "notify": true, "priority": "high", "work_order_id": 864, "asset": {"id": 45, "name": "Freezer"
}, "categories": [{"id": 10, "name": "Refrigeration"
}
], "technicians": [{"id": 3, "name": "John", "surname": "Doe"
}
], "vendors": [{"id": 32, "name": "ABC Corp."
}
], "due_date": "2025-07-17T12:00:00Z", "completed_at": "2025-07-15T09:30:00Z", "images": [{"id": 5, "url": "/api/v1/store/attachments/image/5/upload/d9a6433a7e8acdfaa8dce1f339172449.jpg", "download_url": "../dictionary", "size": 2017802, "type": "image/jpeg", "name": "conference-room-photo.jpg", "attachment_urls": {"small": "/api/v1/store/attachments/image/5/upload/small-f3687c1c901ce528370aac370f888ed3.jpg", "medium": "/api/v1/store/attachments/image/5/upload/medium-f0dfda3ad1ea6b708d46adbf57d6bed1.jpg", "large": "/api/v1/store/attachments/image/5/upload/large-1b4dc08567e1df9f550b5c75a174f915.jpg"
}
}
], "documents": [{"id": 6, "url": "/api/v1/store/attachments/document/6/upload/45bcc85b9513c2c4302b468c4694ae16.pdf", "download_url": "../dictionary", "size": 39777, "type": "application/pdf", "name": "asset-manual.pdf"
}
], "created_at": "2025-07-17T19:19:20Z", "updated_at": "2025-09-24T14:20:25Z", "created_by": {"id": 1, "name": "John", "surname": "Doe"
}, "updated_by": {"id": 2, "name": "Alice", "surname": "Johnson"
}
},
}List requests query Parameters| search | | | sort | string Default: "created_at desc" Example: sort=created_at desc Sort by field ascending or descending
| | object Example: filter[title_cont]=building Filter using filter[field_matcher] syntax
| | page | | | per_page | |
US based Click Maint API server
https://app.clickmaint.com/api/v1/requests Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/requests Response samples Content typeapplication/json {"status": "success", "data": [{"id": 1126, "title": "Fix water leakage in Freezer", "description": "Water leakage due to blocked defrost drain", "status": "on_hold", "priority": "high", "work_order_id": 864, "asset": {"id": 45, "name": "Freezer"
}, "categories": [{"id": 10, "name": "Refrigeration"
}
], "technicians": [{"id": 3, "name": "John", "surname": "Doe"
}
], "vendors": [{"id": 32, "name": "ABC Corp."
}
], "due_date": "2025-07-17T12:00:00Z", "completed_at": "2025-07-15T09:30:00Z", "comments_count": 2, "created_at": "2025-07-17T19:19:20Z", "updated_at": "2025-09-24T14:20:25Z", "created_by": {"id": 1, "name": "John", "surname": "Doe"
}, "updated_by": {"id": 2, "name": "Alice", "surname": "Johnson"
}
}
], "meta": {"pagination": {"total": 50, "page": 1, "per_page": 25, "total_pages": 2
}, "search": "Building A",
}
}US based Click Maint API server
https://app.clickmaint.com/api/v1/requests/{id} Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/requests/{id} Response samples Content typeapplication/json {"status": "success", "data": {"id": 1126, "title": "Fix water leakage in Freezer", "description": "Water leakage due to blocked defrost drain", "status": "on_hold", "notify": true, "priority": "high", "work_order_id": 864, "asset": {"id": 45, "name": "Freezer"
}, "categories": [{"id": 10, "name": "Refrigeration"
}
], "technicians": [{"id": 3, "name": "John", "surname": "Doe"
}
], "vendors": [{"id": 32, "name": "ABC Corp."
}
], "due_date": "2025-07-17T12:00:00Z", "completed_at": "2025-07-15T09:30:00Z", "images": [{"id": 5, "url": "/api/v1/store/attachments/image/5/upload/d9a6433a7e8acdfaa8dce1f339172449.jpg", "download_url": "../dictionary", "size": 2017802, "type": "image/jpeg", "name": "conference-room-photo.jpg", "attachment_urls": {"small": "/api/v1/store/attachments/image/5/upload/small-f3687c1c901ce528370aac370f888ed3.jpg", "medium": "/api/v1/store/attachments/image/5/upload/medium-f0dfda3ad1ea6b708d46adbf57d6bed1.jpg", "large": "/api/v1/store/attachments/image/5/upload/large-1b4dc08567e1df9f550b5c75a174f915.jpg"
}
}
], "documents": [{"id": 6, "url": "/api/v1/store/attachments/document/6/upload/45bcc85b9513c2c4302b468c4694ae16.pdf", "download_url": "../dictionary", "size": 39777, "type": "application/pdf", "name": "asset-manual.pdf"
}
], "created_at": "2025-07-17T19:19:20Z", "updated_at": "2025-09-24T14:20:25Z", "created_by": {"id": 1, "name": "John", "surname": "Doe"
}, "updated_by": {"id": 2, "name": "Alice", "surname": "Johnson"
}
},
}Update request Request Body schema: application/jsonFields to update on Request
required | |
US based Click Maint API server
https://app.clickmaint.com/api/v1/requests/{id} Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/requests/{id} Request samples Content typeapplication/json {"work_order_request": {"title": "Fix water leakage in Freezer", "description": "Water leakage due to blocked defrost drain", "status": "on_hold", "notify": true, "priority": "high", "location_id": 122, "asset_id": 45, "due_date": "2025-07-17T12:00:00Z",
}
} Response samples Content typeapplication/json {"status": "success", "data": {"id": 1126, "title": "Fix water leakage in Freezer", "description": "Water leakage due to blocked defrost drain", "status": "on_hold", "notify": true, "priority": "high", "work_order_id": 864, "asset": {"id": 45, "name": "Freezer"
}, "categories": [{"id": 10, "name": "Refrigeration"
}
], "technicians": [{"id": 3, "name": "John", "surname": "Doe"
}
], "vendors": [{"id": 32, "name": "ABC Corp."
}
], "due_date": "2025-07-17T12:00:00Z", "completed_at": "2025-07-15T09:30:00Z", "images": [{"id": 5, "url": "/api/v1/store/attachments/image/5/upload/d9a6433a7e8acdfaa8dce1f339172449.jpg", "download_url": "../dictionary", "size": 2017802, "type": "image/jpeg", "name": "conference-room-photo.jpg", "attachment_urls": {"small": "/api/v1/store/attachments/image/5/upload/small-f3687c1c901ce528370aac370f888ed3.jpg", "medium": "/api/v1/store/attachments/image/5/upload/medium-f0dfda3ad1ea6b708d46adbf57d6bed1.jpg", "large": "/api/v1/store/attachments/image/5/upload/large-1b4dc08567e1df9f550b5c75a174f915.jpg"
}
}
], "documents": [{"id": 6, "url": "/api/v1/store/attachments/document/6/upload/45bcc85b9513c2c4302b468c4694ae16.pdf", "download_url": "../dictionary", "size": 39777, "type": "application/pdf", "name": "asset-manual.pdf"
}
], "created_at": "2025-07-17T19:19:20Z", "updated_at": "2025-09-24T14:20:25Z", "created_by": {"id": 1, "name": "John", "surname": "Doe"
}, "updated_by": {"id": 2, "name": "Alice", "surname": "Johnson"
}
},
}US based Click Maint API server
https://app.clickmaint.com/api/v1/requests/{id} Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/requests/{id} Response samples Content typeapplication/json {"status": "error", "message": "string"
}Create new work order Request Body schema: application/jsonUS based Click Maint API server
https://app.clickmaint.com/api/v1/work_orders Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/work_orders Request samples Content typeapplication/json {"work_order": {"title": "Fix water leakage in Freezer", "type": "reactive", "description": "Water leakage due to blocked defrost drain", "priority": "high", "work_order_request_id": 864, "due_date": "2025-07-17T12:00:00Z", "completed_at": "2025-07-15T09:30:00Z", "location_id": 122, "asset_id": 45, "status_id": 5, "procedure_template_ids": [], "notify_vendors_on_create": "yes", "notify_vendors_on_update": "yes",
}
} Response samples Content typeapplication/json {"status": "success", "data": {"id": 1126, "title": "Fix water leakage in Freezer", "description": "Water leakage due to blocked defrost drain", "priority": "high", "type": "reactive", "pm_schedule_id": 78, "procedures": [{"id": 119, "name": "Refrigeration Procedure", "procedure_template_id": 10, "completed_at": "2025-07-15T09:30:00Z"
}
], "status": {"id": 5, "name": "completed", "is_custom": false
}, "work_order_request": {"id": 45, "title": "Fix water leakage in Freezer", "created_at": "2025-07-17T19:19:20Z",
}, "asset": {"id": 45, "name": "Freezer", "status": "online"
}, "downtime_tracking": {"id": 22, "started_at": "2025-07-17T19:19:20Z", "ended_at": "2025-07-19T14:20:25Z", "status": "online"
}, "categories": [{"id": 10, "name": "Refrigeration"
}
], "technicians": [{"id": 3, "name": "John", "surname": "Doe"
}
], "vendors": [{"id": 32, "name": "ABC Corp.", "primary_contact": {"id": 24, "name": "Bob Smith", "email": "bob_smith@example.com", "phone": "1-493-480-9163", "extension": "989"
}
}
], "notify_vendors_on_create": "yes", "notify_vendors_on_update": "yes", "due_date": "2025-07-17T12:00:00Z", "completed_at": "2025-07-15T09:30:00Z", "total_costs": {"labor": 146, "other": 38, "parts": 28.15, "total": 212.15
}, "active_timer_current_user": {}, "images": [{"id": 5, "url": "/api/v1/store/attachments/image/5/upload/d9a6433a7e8acdfaa8dce1f339172449.jpg", "download_url": "../dictionary", "size": 2017802, "type": "image/jpeg", "name": "conference-room-photo.jpg", "attachment_urls": {"small": "/api/v1/store/attachments/image/5/upload/small-f3687c1c901ce528370aac370f888ed3.jpg", "medium": "/api/v1/store/attachments/image/5/upload/medium-f0dfda3ad1ea6b708d46adbf57d6bed1.jpg", "large": "/api/v1/store/attachments/image/5/upload/large-1b4dc08567e1df9f550b5c75a174f915.jpg"
}
}
], "documents": [{"id": 6, "url": "/api/v1/store/attachments/document/6/upload/45bcc85b9513c2c4302b468c4694ae16.pdf", "download_url": "../dictionary", "size": 39777, "type": "application/pdf", "name": "asset-manual.pdf"
}
], "created_at": "2025-07-17T19:19:20Z", "updated_at": "2025-09-24T14:20:25Z", "created_by": {"id": 1, "name": "John", "surname": "Doe"
}, "updated_by": {"id": 2, "name": "Alice", "surname": "Johnson"
}
},
}List work orders query Parameters| search | | | sort | string Default: "created_at desc" Example: sort=created_at desc Sort by field ascending or descending
| | object Example: filter[title_cont]=building Filter using filter[field_matcher] syntax
| | page | | | per_page | |
US based Click Maint API server
https://app.clickmaint.com/api/v1/work_orders Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/work_orders Response samples Content typeapplication/json {"status": "success", "data": [{"id": 1126, "title": "Fix water leakage in Freezer", "description": "Water leakage due to blocked defrost drain", "priority": "high", "type": "reactive", "work_order_request_id": 864, "pm_schedule_id": 78, "status": {"id": 5, "name": "completed", "is_custom": false
}, "comments_count": 2, "asset": {"id": 45, "name": "Freezer", "status": "online"
}, "downtime_tracking": {"id": 22, "started_at": "2025-07-17T19:19:20Z", "ended_at": "2025-07-19T14:20:25Z", "status": "online"
}, "categories": [{"id": 10, "name": "Refrigeration"
}
], "technicians": [{"id": 3, "name": "John", "surname": "Doe"
}
], "vendors": [{"id": 32, "name": "ABC Corp."
}
], "due_date": "2025-07-17T12:00:00Z", "completed_at": "2025-07-15T09:30:00Z", "active_timer_current_user": {}, "created_at": "2025-07-17T19:19:20Z", "updated_at": "2025-09-24T14:20:25Z", "created_by": {"id": 1, "name": "John", "surname": "Doe"
}, "updated_by": {"id": 2, "name": "Alice", "surname": "Johnson"
}
}
], "meta": {"pagination": {"total": 50, "page": 1, "per_page": 25, "total_pages": 2
}, "search": "Building A",
}
}US based Click Maint API server
https://app.clickmaint.com/api/v1/work_orders/{id} Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/work_orders/{id} Response samples Content typeapplication/json {"status": "success", "data": {"id": 1126, "title": "Fix water leakage in Freezer", "description": "Water leakage due to blocked defrost drain", "priority": "high", "type": "reactive", "pm_schedule_id": 78, "procedures": [{"id": 119, "name": "Refrigeration Procedure", "procedure_template_id": 10, "completed_at": "2025-07-15T09:30:00Z"
}
], "status": {"id": 5, "name": "completed", "is_custom": false
}, "work_order_request": {"id": 45, "title": "Fix water leakage in Freezer", "created_at": "2025-07-17T19:19:20Z",
}, "asset": {"id": 45, "name": "Freezer", "status": "online"
}, "downtime_tracking": {"id": 22, "started_at": "2025-07-17T19:19:20Z", "ended_at": "2025-07-19T14:20:25Z", "status": "online"
}, "categories": [{"id": 10, "name": "Refrigeration"
}
], "technicians": [{"id": 3, "name": "John", "surname": "Doe"
}
], "vendors": [{"id": 32, "name": "ABC Corp.", "primary_contact": {"id": 24, "name": "Bob Smith", "email": "bob_smith@example.com", "phone": "1-493-480-9163", "extension": "989"
}
}
], "notify_vendors_on_create": "yes", "notify_vendors_on_update": "yes", "due_date": "2025-07-17T12:00:00Z", "completed_at": "2025-07-15T09:30:00Z", "total_costs": {"labor": 146, "other": 38, "parts": 28.15, "total": 212.15
}, "active_timer_current_user": {}, "images": [{"id": 5, "url": "/api/v1/store/attachments/image/5/upload/d9a6433a7e8acdfaa8dce1f339172449.jpg", "download_url": "../dictionary", "size": 2017802, "type": "image/jpeg", "name": "conference-room-photo.jpg", "attachment_urls": {"small": "/api/v1/store/attachments/image/5/upload/small-f3687c1c901ce528370aac370f888ed3.jpg", "medium": "/api/v1/store/attachments/image/5/upload/medium-f0dfda3ad1ea6b708d46adbf57d6bed1.jpg", "large": "/api/v1/store/attachments/image/5/upload/large-1b4dc08567e1df9f550b5c75a174f915.jpg"
}
}
], "documents": [{"id": 6, "url": "/api/v1/store/attachments/document/6/upload/45bcc85b9513c2c4302b468c4694ae16.pdf", "download_url": "../dictionary", "size": 39777, "type": "application/pdf", "name": "asset-manual.pdf"
}
], "created_at": "2025-07-17T19:19:20Z", "updated_at": "2025-09-24T14:20:25Z", "created_by": {"id": 1, "name": "John", "surname": "Doe"
}, "updated_by": {"id": 2, "name": "Alice", "surname": "Johnson"
}
},
}Update work order Request Body schema: application/jsonFields to update on Work Order
US based Click Maint API server
https://app.clickmaint.com/api/v1/work_orders/{id} Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/work_orders/{id} Request samples Content typeapplication/json {"work_order": {"title": "Fix water leakage in Freezer", "description": "Water leakage due to blocked defrost drain", "priority": "none", "due_date": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z", "location_id": 122, "asset_id": 45, "status_id": 1, "procedure_template_ids": [], "notify_vendors_on_update": "yes",
}
} Response samples Content typeapplication/json {"status": "success", "data": {"id": 1126, "title": "Fix water leakage in Freezer", "description": "Water leakage due to blocked defrost drain", "priority": "high", "type": "reactive", "pm_schedule_id": 78, "procedures": [{"id": 119, "name": "Refrigeration Procedure", "procedure_template_id": 10, "completed_at": "2025-07-15T09:30:00Z"
}
], "status": {"id": 5, "name": "completed", "is_custom": false
}, "work_order_request": {"id": 45, "title": "Fix water leakage in Freezer", "created_at": "2025-07-17T19:19:20Z",
}, "asset": {"id": 45, "name": "Freezer", "status": "online"
}, "downtime_tracking": {"id": 22, "started_at": "2025-07-17T19:19:20Z", "ended_at": "2025-07-19T14:20:25Z", "status": "online"
}, "categories": [{"id": 10, "name": "Refrigeration"
}
], "technicians": [{"id": 3, "name": "John", "surname": "Doe"
}
], "vendors": [{"id": 32, "name": "ABC Corp.", "primary_contact": {"id": 24, "name": "Bob Smith", "email": "bob_smith@example.com", "phone": "1-493-480-9163", "extension": "989"
}
}
], "notify_vendors_on_create": "yes", "notify_vendors_on_update": "yes", "due_date": "2025-07-17T12:00:00Z", "completed_at": "2025-07-15T09:30:00Z", "total_costs": {"labor": 146, "other": 38, "parts": 28.15, "total": 212.15
}, "active_timer_current_user": {}, "images": [{"id": 5, "url": "/api/v1/store/attachments/image/5/upload/d9a6433a7e8acdfaa8dce1f339172449.jpg", "download_url": "../dictionary", "size": 2017802, "type": "image/jpeg", "name": "conference-room-photo.jpg", "attachment_urls": {"small": "/api/v1/store/attachments/image/5/upload/small-f3687c1c901ce528370aac370f888ed3.jpg", "medium": "/api/v1/store/attachments/image/5/upload/medium-f0dfda3ad1ea6b708d46adbf57d6bed1.jpg", "large": "/api/v1/store/attachments/image/5/upload/large-1b4dc08567e1df9f550b5c75a174f915.jpg"
}
}
], "documents": [{"id": 6, "url": "/api/v1/store/attachments/document/6/upload/45bcc85b9513c2c4302b468c4694ae16.pdf", "download_url": "../dictionary", "size": 39777, "type": "application/pdf", "name": "asset-manual.pdf"
}
], "created_at": "2025-07-17T19:19:20Z", "updated_at": "2025-09-24T14:20:25Z", "created_by": {"id": 1, "name": "John", "surname": "Doe"
}, "updated_by": {"id": 2, "name": "Alice", "surname": "Johnson"
}
},
}US based Click Maint API server
https://app.clickmaint.com/api/v1/work_orders/{id} Canada based Click Maint API server
https://app.clickmaint.ca/api/v1/work_orders/{id} Response samples Content typeapplication/json {"status": "error", "message": "string"
} |