CATS API Documentation



API v2 to be deprecated October 1, 2017
API v3 is now out of beta and ready for production use. As a result, API v2 will be disabled on October 1, 2017. It is highly recommended that any new API development be done using v3. We ask that existing integrations built with v2 begin planning their migration strategy as soon as possible to avoid service interruptions after the deprecation date.

Resources: API v3 documentationHelp forum

API Introduction

About the API
The CATS API (Application Programming Interface) allows for programmatic retrieval and manipulation of CATS data.

API requests are sent over HTTP 1.1 and can be accessed by just about any programming language or platform—or even without a programming language simply by typing a URL string into your browser.

Accessing your data
API requests use a "transaction code" instead of your CATS username and password.

Transaction codes are generated by the site administrator and serve as a password along with the company ID which serves as a username. Transaction codes should be kept secret!

There is little difference between a CATS user and a CATS API user. When the CATS API performs an action such as adding a record, the notes explaining who performed that action will be linked to that user. Permissions also work the same, although read-only users are not allowed to access API functions.

Creating a transaction code
Create and manage transaction codes from the "Web Services (API)" section of the "User Management" screen in CATS.

Request limits
API requests are limited to 100 per hour per user license. Please contact support if your application needs to make requests exceeding this limit.

Getting help
The CATS API Google Group is a great place to ask questions and find answers.

Public Libraries
Download a library in your development language to speed up implementation. Make direct calls to CATS API functions in your language of choice. These libraries are automatically updated when additional functions are available.