ToolHound API Call
ToolHound provides a full RESTful API. The current API can be found by appending /api-docs to the URL you use to log into ToolHound.
Welcome to ToolHound 6
Getting Started implementing ToolHound 6
Getting Started - Start Here
Getting Started - Implementation Step Summary
Getting Started - Onboarding Meeting
Getting Started - Installing ToolHound On-Premise
Getting Started - Review Company Settings
Getting Started - Location Setup
Getting Started - Utilities Setup
Getting Started - Personnel Setup
Getting Started - Inventory Setup
Getting Started - Transaction Setup
Getting Started - Service Setup
Getting Started - Purchasing Setup
Getting Started - Transaction Rental Setup
Getting Started - Transfer Rental Setup
Getting Started - "Go Live" Check List
Installing ToolHound 6 On-Premise
Technical Requirements
Installing ToolHound 6 On-Premise
Installing ToolHound 6 On-Premise as an Azure App Service
Installing ToolHound 6 On-Premise using Windows Authentication
Troubleshooting the Installation
Upgrading from ToolHound 5
Registering the ToolHound 6 Database
Configuring Email - On Premise only
Configuring Single Sign On (SSO) - On Premise Only
Setting up Microsoft authorization for SSO
Setting up Google authorization for SSO
Configuring Two Factor Authentication (2FA) - On Premise Only
ToolHound Browser
Logging In to the TH6 Browser
Navigation
Home
Message
Favorites
Links
Data ToolBar
Attachments
About Attachments
Adding an Attachment
Editing an Attachment
Viewing an Attachment
Deleting an Attachment
Other Commands
User Menu
Transactions
Issue/Return
About Issue / Return
Issuing Inventory
Returning Inventory
Exceptions Returning Bulk or Consumable Inventory
Create Requisition
About Create Requisition
Catalog tab for Create Requisition
Selected Items tab for Create Requisition
Creating a Requisition
Pick Requisition
About Pick Requisition
General tab for Pick Requisition
Details tab for Pick Requisition
Substitutions tab for Pick Requisition
Picking a Requisition
Reassign Assets
Transactions
About Transactions
General tab for Transactions
Details tab for Transactions
Replaced With tab for Transactions
Exchanged For tab for Transactions
Looking up a Transaction
Editing a Transaction
Requisitions
About Transaction Requisitions
General tab for Requisitions
Details tab for Requisitions
Approvals tab for Requisitions
Substitutions tab for Requisitions
Transaction Details tab for Requisitions
Looking up a Requisition
Editing a Requisition
Canceling a Requisition
Deleting a Requisition
Approving a Requisition
Transaction Types
About Transaction Types
Adding a Transaction Type
Looking Up a Transaction Type
Editing a Transaction Type
Deleting a Transaction Type
Return Statuses
About Return Statuses
Adding a Return Status
Looking Up a Return Status
Editing a Return Status
Deleting a Return Status
Issued Assets Email
Inventory
Part Numbers
About Part Numbers
General tab for Part Numbers
Alternate IDs tab for Part Numbers
Stocking Points Tab for Part Numbers
Items tab for Part Numbers
Notes tab for Part Numbers
Tasks tab for Part Numbers
Vendors tab for Part Numbers
Transaction History tab for Part Numbers
Certifications tab for Part Numbers
Transaction Rental Rates tab for Part Numbers
Transfer Rental Rates tab for Part Numbers
Adding Part Numbers
Looking Up Part Numbers
Editing Part Numbers
Adding a Picture to a Part Number
Changing the Picture on a Part Number
Adding a Task to a Part Number
Removing a Task from a Part Number
Adding a Vendor to a Part Number
Add a Certification to a Part Number
Deleting Part Numbers
Serialized Items
About Serialized Items
General tab for Serialized Items
Purchase Rental information tab for Serialized Items
Alternate IDs tab for Serialized Items
Notes tab for Serialized Items
Transaction History tab for Serialized Items
Service Requirements tab for Serialized Items
Setting Initial Service Details for Serialized Items
Adding a Service Requirement for Serialized Items
Removing a Service Requirement for a Serialized Item
Work Order History tab for Serialized Items
Adding a Serialized Item
Looking Up a Serialized Item
Editing a Serialized Item
Deleting a Serialized Item
Kits
About Kits
Creating a Serialized Kit
Creating a Bulk Kit
About Dissolving Kits
Creating a Dissolving Kit
Replenishing Consumables in a Kit
Removing Items from a Kit
Deleting a Serialized Kit
About Serialized Kits & Counts
Retired Items
Adjust Inventory
Counts
Create Counts
Counts
About Counts
Counted tab for Counts
Discrepancies tab for Counts
Final tab for Counts
Looking Up a Count
Updating a Count
Deleting a Count
Close Count
Categories
About Categories and Sub Categories
Adding a Category and Sub Category
Looking Up a Category or Sub Category
Editing a Category and Sub Category
Deleting a Category and Sub Category
Manufacturers
About Manufacturers
Adding Manufacturers
Looking Up Manufacturers
Editing Manufacturers
Deleting Manufacturers
Inventory Types
Units of Measure
About Units of Measure
Adding a Unit of Measure
Looking Up a Unit of Measure
Editing a Unit of Measure
Deleting a Unit of Measure
Inventory Statuses
About Inventory Statuses
Adding an Inventory Status
Looking Up an Inventory Status
Editing an Inventory Status
Deleting an Inventory Status
Conditions
Departments
About Departments
Adding a Department
Looking up a Department
Editing a Department
Deleting a Department
Rental Periods
Vendors
About Vendors
General tab for Vendors
Notes tab for Vendors
Purchase History tab for Vendors
Adding a Vendor
Looking Up a Vendor
Editing a Vendor
Deleting a Vendor
Change Item Status
About Change Item Status
Changing the Inventory Status of an Item
Looking Up an Item Inventory Status Change
Change Inventory Type
Merge Part Number
Merge Item
Calculate Min/Max
Personnel
Personnel
About Personnel
General tab for Personnel
Notes tab for Personnel
Certifications tab for Personnel
Transaction History tab for Personnel
Adding Personnel
Looking Up Personnel
Editing Personnel
Adding a Picture to a Personnel record
Changing the Picture on a Personnel record
Adding a Certification to Personnel
Removing a Certification from Personnel
Deleting Personnel
Employers
Crafts
Certifications
Locations
Locations
About Locations
Address tab for Locations
Settings tab for Locations
Document tab for Locations
Transaction History tab for Locations
Adding a Location
Looking Up a Location
Editing a Location
Deleting a Location
Location Types
About Location Types
Adding a Location Type
Looking Up a Location Type
Editing a Location Type
Deleting a Location Type
Transfers
About Transfers
General tab for Transfers
Details tab for Transfers
Receipts tab for Transfers
Lost in Transit tab for Transfers
Creating a Transfer
Looking Up a Transfer
Cancelling a Transfer
Receive Transfers
Transfer Receipts
About Transfer Receipts
General tab for Transfer Receipts
Details tab for Transfer Receipts
Looking Up a Transfer Receipt
Editing a Transfer Receipt
Create Transfer Request
About Create Transfer Request
General tab for Create Transfer Request
Catalog tab for Create Transfer Request
Selected Items tab for Create Transfer Request
Creating a Transfer Request
Pick Transfer Request
About Pick Transfer Request
General tab for Pick Transfer Request
Details tab for Pick Transfer Request
Substitutions tab for Pick Transfer Request
Picking a Transfer Request
Transfer Requests
About Transfer Requests
General tab for Transfer Requests
Details tab for Transfer Requests
Substitutions tab for Transfer Requests
Approvals tab for Transfer Requests
Transfer Details tab for Transfer Requests
Adding a Transfer Request
Looking up a Transfer Request
Editing a Transfer Request
Canceling a Transfer Request
Deleting a Transfer Request
Create Lost In Transit
About Create Lost In Transit
General tab for Create Lost in Transit
Details tab for Create Lost in Transit
Record Inventory Lost In Transit
Lost in Transit
About Lost in Transit
General tab for Lost in Transit
Details tab for Lost in Transit
Looking Up a Lost in Transit Record
Editing a Lost in Transit Record
Transfer All
Close Project
Transfer Types
About Transfer Types
Adding a Transfer Type
Looking Up a Transfer Type
Editing a Transfer Type
Deleting a Transfer Type
Unapprove Transfer Request
Location Services
Purchasing
About Purchasing
Purchase Orders
About Purchase Orders
General tab for Purchase Orders
Details tab for Purchase Orders
Approvals tab for Purchase Orders
Creating a Purchase Order
Looking Up a Purchase Order
Editing a Purchase Order
Canceling a Purchase Order
Approving a Purchase Order
Closing a PO Line Item
Reorder Worksheet
Vendors
Create Purchase Requisition
About Create Purchase Requisition
General tab for Create Purchase Requisitions
Catalog tab for Create Purchase Requisition
Selected Items tab for Purchase Requisitions
Creating a Purchase Requisition
Purchase Requisition
About Purchase Requisitions
General tab for Purchase Requisition
Details tab for Purchase Requisition
Approvals tab for Purchase Requisition
Adding a Purchase Requisition
Looking Up a Purchase Requisition
Canceling a Purchase Requisition
Deleting a Purchase Requisition
Approving a Purchase Requisition
Generating a Purchase Order from a Purchase Requisition
Purchase Order tab for Purchase Requisition
Receive Inventory
About Receive Inventory
General tab for Receive Inventory
Items to Receive tab for Receive Inventory
Items Received tab for Receive Inventory
Receiving Inventory with Purchase Order
Receiving Inventory without a Purchase Order
Inventory Receipts
About Inventory Receipts
General tab for Inventory Receipts
Items Received tab for Inventory Receipts
Looking Up an Inventory Receipt
Editing an Inventory Receipt
Create Inventory Return
Inventory Returns
Return Codes
About Return Codes
Adding a Return Code
Looking Up a Return Code
Editing a Return Code
Deleting a Return Code
Payment Terms
About Payment Terms
Adding a Payment Term
Looking Up a Payment Term
Editing a Payment Term
Deleting a Payment Term
INCO Terms
About INCO Terms
Adding an INCO Term
Looking Up an INCO Term
Editing an INCO Term
Deleting an INCO Term
Unapprove PO
Unapprove PO Requisition
Service
About Service
Service Requests
About Service Requests
Adding a Service Request
Looking Up a Service Request
Editing a Service Request
Deleting a Service Request
Service Due
About Service Due
Date-Based tasks tab for Service Due
Meter-Based tasks tab for Service Due
Using Service Due to generate Work Orders for Date-Based Tasks
Using Service Due to generate Work Orders for Meter-Based Tasks
Meter Readings
Work Orders
About Work Orders
Asset tab for Work Orders
Request tab for Work Orders
Work To Do tab for Work Orders
Completion tab for Work Orders
Notes tab for Work Orders
Required Inventory tab for Work Orders
Charges tab for Work Orders
Approvals tab for Work Orders
Transaction Details tab for Work Orders
Adding a Work Order
Looking Up a Work Order
Editing a Work Order
Deleting a Work Order
Approving a Work Order
Changing an Item Status from a Work Order
Issuing Required Inventory from a Work Order
Adding Labor Costs to a Work Order
Adding External Charges to a Work Order
Closing a Work Order
Tasks
About Service Tasks
General tab for Tasks
Instructions tab for Tasks
Required Material tab for Tasks
Required Tools tab for Tasks
Supersede List tab for Tasks
Adding a Task
Looking Up a Task
Editing a Task
Deleting a Task
Meters
Work Order Types
About Work Order Types
Adding a Work Order Type
Looking Up a Work Order Type
Editing a Work Order Type
Deleting a Work Order Type
Work Order Statuses
About Work Order Statuses
Adding a Work Order Status
Looking Up a Work Order Status
Editing a Work Order Status
Deleting a Work Order Status
Work Order Priorities
About Work Order Priorities
Adding a Work Order Priority
Looking up a Work Order Priority
Editing a Work Order Priority
Deleting a Work Order Priority
Failure Codes
About Failure Codes
Adding a Failure Code
Looking Up a Failure Code
Editing a Failure Code
Deleting a Failure Code
Check Lists
Transfer Rentals
About Transfer Rental
Transfer Charges
About Transfer Charges
Looking up a Charge - Transfer Rental
Editing a Charge - Transfer Rental
Deleting a Charge - Transfer Rental
Adding a Manual Charge - Transfer Rental
Transfer On Rent
About Transfer On Rent
Looking up On Rent Items - Transfer Rental
Changing the Status for an Item On Rent - Transfer Rental
Partial Billing - Transfer Rentals
Transfer Rate Sheets
About Transfer Rate Sheets
Creating a Transfer Rate Sheet
Adding Part Numbers to a Transfer Rate Sheet
Configuring Renting Locations for Transfer Rate Sheets
Updating Transfer Rate Sheet Rates
Looking up a Transfer Rate Sheet
Editing a Transfer Rate Sheet
Status Change - Transfer Rental
Rental Periods
Transaction Rentals
About Transaction Rentals
Transaction Charges
About Transaction Charges
Looking Up a Charge - Transaction Rental
Editing a Charge - Transaction Rental
Deleting a Charge - Transaction Rental
Adding a Manual Charge - Transaction Rental
Transaction On Rent
About Transaction On Rent
Looking up an On Rent Item - Transaction Rental
Changing the Status for an Item On Rent - Transaction Rental
Exchanging an Item On Rent - Transaction Rental
Partial Billing - Transaction Rental
Transaction Rate Sheets
About Transaction Rate Sheets
Details tab for Transaction Rate Sheet
Employers tab for Transaction Rate Sheet
Locations tab - Transaction Rate Sheet
Creating a Transaction Rate Sheet
Adding Part Numbers to a Transaction Rate Sheet
Looking Up a Transaction Rate Sheet
Editing a Transaction Rate Sheet
Deleting a Transaction Rate Sheet
Adding Renters to a Transaction Rate Sheet
Updating Rates on a Transaction Rate Sheet
Status Change - Transaction Rental
Rate Sheet Holidays
Utilities
Settings
About Settings
About Company Settings
About Options Settings
About Authentication Settings
About Authentication
About Email Settings
About Home Message Settings
Recycle Bin
About the Recycle Bin
Restoring Deleted Data from the Recycle Bin
Permanently Deleting Data from the Recycle Bin
Cost Codes
Jobs
About Jobs and Sub Jobs
Adding Jobs and Sub Jobs
Adding Cost Codes to Sub Jobs
Looking Up a Job
Editing a Job or Sub Job
Deleting a Job or Sub Job
Removing Cost Codes from Sub Jobs
Approval Process
About Approval Processes
Adding an Approval Process
Looking Up an Approval Process
Editing an Approval Process
Modifying Approvers for an Approval Process
Deleting an Approval Process
Roles
Users
Currencies
Import Data
About Import Data
Data to Import
Downloading Import Templates
Preparing to Import Data
Completing the Templates
Importing Data
Importing Pictures and File Attachments
Notifications
About Notifications
Notifications Event List
About Background Notifications
Configuring Background Notification Frequency - On-Premise only
Configuring the Background Notification Database List - On-Premise only
Adding a Notification
Looking Up a Notification
Editing a Notification
Deleting a Notification
Command Window
License Information
Links for Roles
Background Notification
Menu Captions
Database Utilities
Reporting
Reports
About Reports
About Reports
About the Reports Toolbar
About the Report Output Toolbar
About the Report Viewer
Setting Report Favorites
Favorites for Reports
Report Lists
Transaction Reports
Inventory Reports
Location Reports
Personnel Reports
Purchasing Reports
Service Reports
Transfer Rental Reports
Transaction Rental Reports
Utilities Reports
Running Reports
Running Reports
Using Quick Filters for Reports
About Advanced Filters for Reports
Using Advanced Filters for Reports
Changing the Sort for Reports
Emailing Reports
Scheduling Reports
About Scheduling Reports
Enabling Scheduled Reports - On-Premise only
Configuring the Scheduled Reports Database List - On-Premise only
Scheduling a Report
Modifying a Scheduled Report
Removing a Scheduled Report
Customizing Reports
System Reports Update
Scheduled Reports
Report Queue
Dashboard
ToolHound Mobile
Getting Started with TH6 Mobile
About Scanners, Mobile Devices & Smart Phones for TH6 Mobile
Setting up a new Mobile Scanner for TH6 Mobile
Installing ToolHound Mobile from Apple App Store or Android Play
Installing ToolHound Mobile for Android from a Downloaded APK File
Logging In to TH6 Mobile
Navigating on TH6 Mobile
About Settings for TH6 Mobile
Changing Your Password on TH6 Mobile
Configuring the Bar Code Scanner on a Zebra Device
Configuring the Bar Code Scanner on a Honeywell Device
Configuring the CS108 RFID Scanner
About Pausing Transactions for TH6 Mobile
Transactions on TH6 Mobile
Issue Return on TH6 Mobile
About Issue / Return on TH6 Mobile
Issue / Return Cart tab on TH6 Mobile
Issuing and Returning on TH6 Mobile
Requisitions on TH6 Mobile
About Requisitions on TH6 Mobile
Viewing a Requisition on TH6 Mobile
Creating a Requisition on TH6 Mobile
Copying a Requisition on TH6 Mobile
Pick Requisition on TH6 Mobile
Issued Items on TH6 Mobile
About Issued Items on TH6 Mobile
Looking Up Issued Items on TH6 Mobile
Emailing Issued Items on TH6 Mobile
Delivery Signature on TH6 Mobile
Reassign Assets on TH6 Mobile
Inventory on TH6 Mobile
Item Lookup on TH6 Mobile
Count on TH6 Mobile
About Counts on TH6 Mobile
Creating a New Count on TH6 Mobile
Updating an Existing Count on TH6 Mobile
Adjust Inventory on TH6 Mobile
Change / Add Item ID on TH6 Mobile
Change Bin on TH6 Mobile
Serialized Items on TH6 Mobile
Serialized Kits on TH6 Mobile
About Serialized Kits on TH6 Mobile
Adding a Serialized Kit on TH6 Mobile
Viewing a Serialized Kit on TH6 Mobile
Changing the Contents of a Serialized Kit on TH6 Mobile
Replenishing Consumables in a Kit on TH6 Mobile
Part Number on TH6 Mobile
Personnel on TH6 Mobile
Locations on TH6 Mobile
Transfer on TH6 Mobile
About Transfer on TH6 Mobile
Transfer Cart tab on TH6 Mobile
Transfer Notes tab on TH6 Mobile
Creating a Transfer on TH6 Mobile
Receive Transfer on TH6 Mobile
About Receive Transfer on TH6 Mobile
Receive Transfer Home tab on TH6 Mobile
Receive Transfer Cart tab on TH6 Mobile
Receiving a Transfer on TH6 Mobile
Transfer Request on TH6 Mobile
About Transfer Request on TH6 Mobile
Viewing a Transfer Request on TH6 Mobile
Creating a Transfer Request on TH6 Mobile
Pick Request on TH6 Mobile
Purchasing on TH6 Mobile
Service on TH6 Mobile
ToolHound Kiosk
About ToolHound Kiosk
Installing ToolHound Kiosk
Kiosk Settings
TH6 Kiosk Main Page
Check Out and Return
About Check Out and Return for TH6 Kiosk
Checking Out inventory on TH6 Kiosk
Returning Inventory on TH6 Kiosk
Changing a PIN on TH6 Kiosk
Item Lookup
ToolHound 6 API
FAQ
Errors FAQ
Why am I getting an error logging in to the Cloud?
What does "Login failed for user" mean?
What does "Could not connect to SQL Server. Check your settings" mean?
What does "Cannot access the server. Please check that the address you entered is correct." mean?
What does "Number of allowed ... has been exceeded" mean?
What does "The server connection has been lost." mean?
What does "SQLite.SQLiteException Cannot add a PRIMARY KEY column" mean?
What does "NoMatch" when logging in on the Mobile app mean?
What does "Error - String or binary data would be truncated" mean?
What does "Object reference not set to an instance of an object" mean?
How is ToolHound licensed?
Am I using ToolHound Cloud or ToolHound On Premise?
What training options are available?
Are there video tutorials?
What does !!! in front of a part number, item ID or entity ID mean?
What does "Item ID is already in use" mean?
What is non stock inventory?
Why am I missing rental charges?
What does Source mean?
Who is the ToolHound administrator?
What is an Entity or Entity ID?
What does Visibility mean?
Why are some fields automatically filled?
Why are there no costs on Issued Assets or Consumables reports?
What does "Invalid Entity ID" mean?
Is there a user group?
Can consumables be returned?
Can I change an Item ID?
What is a Billing Location?
Can I change a transfer date?
What is an Item ID? Primary ID vs Alternate ID?
What is a Conversion Factor?
Why am I not getting email notifications?
Who is our Account Manager?
Why can't I see costs?
What is Project Cost?
How do I
Replace a Missing or Damaged Barcode or QR Code
Order Barcode or QR Code Labels
Print barcode labels or QR code labels
Perform a Physical Inventory
Add New Inventory or Add New Tools
Return Damaged Tools
Report on Inventory
Report on Lost Tools
Add a Picture to a Part Number
Change the Description on a Tool or Other Inventory
Add Costs or Change Costs
Change a User's Password
Change My Password
Track Consumable Inventory by Lot Numbers
Change the Part Number for a Serialized Item
Set Up New Transaction Rate Sheets Quickly
Set Up New Transfer Rate Sheets Quickly
Update the Bin Shelf for a single item ID
Update the Bin Shelf for Multiple Items at One Time
Delete a transaction (issue / return)
Set Min and Max quantities
Change the Stocking Location for an item
Change Captions or Labels
Request a feature or enhancement
Delete all inventory or start over
Add a Price or Change Prices
Change a transaction type on a transaction
Change the Color
Add Rentals
Stop Rent or Pause Rent
View Issued Items / Report on Issued Items
View the Purchase History for a Part
Close a Project - Entity or Stocking Location
Export Data to Excel
Delete an Inventory Receipt
Write off inventory
Look up an Item - tool, equipment, or material
Print a Requisition (Pick Ticket)
Print a Transfer Request
Find Paused or Idle Items On Rent
Print a Work Order
Updates
Previous Updates
2024 Updates
6.2024.1009.0
6.2024.918.0
6.2024.612.0
6.2024.530.0
6.2024.520.0
TH6 Kiosk 2024.4.10.0
TH6 Kiosk 2024.4.2.0
6.2024.314.0
6.2024.223.0
6.2024.102.0
2023 Updates
6.2023.12.17
6.2023.12.15
6.2023.12.13
6.2023.9.15
6.2023.8.25
6.2023.8.16
6.2023.06.02 / 6.2023.06.09
6.2023.5.31
6.2023.3.29
6.2023.1.25
6.2023.1.17 / 6.2023.1.19
2022 Updates
6.2022.11.04
6.2022.10.27
6.2022.8.15
6.2022.7.8
6.2022.6.22
6.2022.6.15
6.2022.4.6
6.2022.3.30
6.2022.3.25
6.2022.1.13
2021 Updates
Updating Instructions for On Premise
Installing an Update using the Patch
Installing an Update using the Installer
Installing an Update from 6.2022.8.15 or prior using the Patch
Installing an Update from 6.2024.520.0 or later
Release Notes
6.2025.129.0
Copyright
Third Party Copyrights
Bootstrap
Bootstrap-DatePicker
ColorPicker
DataTables
FancyTree
form-data
Globalize
jQuery
jQuery TimePicker
jQuery Ui
jQuery Ui Context Menu
jQuery Validate
jQuery Validation UnObtrusive
JS Cookie
JSZip
Knockout
Moment
Popper
QrCode
Quill
SummerNote
Tool Connect
ui-ContextMenu
Copyright © 2020 - 2025 - ToolHound Inc. - All Rights Reserved