Overview

This documentation describes the resources that make up the ToolWatch Enterprise API. Please visit ToolWatch Developer Support for issues or questions.

Schema

All API access is secure and can be accessed through https://api.toolwatch.net.
All requests and responses will be sent and received as JSON.

Authentication

Retrieving an Authorization Token

Visit the Authentication POST endpoint for more information about the expected request body.
Example HTTP request: POST /Authentication { "Email": "api-user@example.com", "Password": "123456", "AccessKey": key_guid }

Using the Authorization Token

Once you have retrieved a token, pass it as a header with your HTTP requests to other endpoints.
If the Authorization header is missing, requests will return 401 Unauthorized.

List Visibility and Pagination

Default visibility

List API's will hide items that are not visible to the authenticated user's pinned stockpoint.
In addition, deleted and retired items will not be shown by default.

Pagination

Requests that return a list of items will be paginated. The Page and PageSize parameters allow an API user to control the result set.

Example HTTP request:GET /Category?page=2&pagesize=50

Not Visible Items

Tools that are flagged as "not visible" are not returned by the API by default.
To include "not visible" tools in the response, add the "includeNotVisible" query parameter to your request.

Example HTTP request:GET /Category?includeNotVisible=true

Retired Items

Tools that are flagged as retired are not returned by the API by default.
To include retired tools in the response, add the "includeRetired" query parameter to your request.

Example HTTP request:GET /Category?includeRetired=true

Deleted Items

Tools that are flagged as deleted are not returned by the API by default.
To include deleted tools in the response, add the "includeDeleted" query parameter to your request.

Example HTTP request:GET /Category?includeDeleted=true