To access the ToolWatch API, use a programming language that can submit HTTP requests and parse either JSON or XML. We are currently creating sample code for C# and VB.NET.

Your application must authenticate and receive a token before issuing any other request.

Authorization requires you to have two things

Use a ToolWatch Sandbox environment to test your code before using it with live production data. The Sandbox environment contains a copy of production data, including actual user logins. Testing against it will provide you with an experience that closely matches what you will encounter with your production data. A member of the ToolWatch Support team can assist you in getting started with a Sandbox account.

The ToolWatch API is a RESTful web service.

Every request will return an appropriate status code.

HTTP 1.1 status code definitions

Note that some endpoints that return lists of resources will return a 404 status code in the case where no items exist in the collection. This behavior is documented on the individual endpoints.

Some endpoints will return a 403 and a message indicating that your organization does not have access. This indicates that there is additional setup/configuration required for your organization to use the associated endpoint. As noted in the message, please contact support to inquire about access.

By default, the API returns responses in JSON.

Adding the querystring parameter

will force the API to return responses in POX (Plain Old XML).

ToolWatch provides a C# client library for exercising all of the endpoints and resources documented here.

To download the library and see how to set it up, go to ToolWatch API: Client Library.