CATS API Documentation

(CATS API 2.0)


API Functions
  Function
add_activity
add_attachment
add_candidate
add_company
add_contact
add_email_activity
add_joborder
add_pipeline
add_quick_note
apply_joborder
candidate_login
delete_candidate
delete_company
delete_contact
delete_joborder
get_activities
get_applicants
get_applications
get_attachment
get_attachments
get_backup
get_candidate
get_candidates
get_companies
get_company
get_company_select
get_contact
get_contacts
get_joborder
get_joborder_applications
get_joborders
get_lists
get_magic_preview
get_options
get_pipelines
get_portal_columns
get_portal_joborders
get_public_joborders
get_resume
get_statuses
get_tasks
parse_resume
portal_forgot_password
portal_login
portal_profile_update
publish
register_client
resume_inbox
search
send_to_friend
set_status
toolbar_parse
update_attachment
update_candidate
update_company
update_contact
update_joborder

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 key" 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
To create a new transaction code, log into CATS. Click on the "Settings" tab, then "Administration" and finally "User Management." The second section named "Web Services (API)" contains all the transaction codes you currenly have issued. You can delete codes, or select a user from the drop down box and select "Generate New Tranaction Code" to issue a new code.

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.
Copyright ©2012 CATS Software, Inc. All rights reserved.