search

(CATS API 2.0)

Search for records in the database.


[ List of API Functions ] [ Frequently Asked Questions ]

Base URL
https://[subdomain].catsone.com/api/search?transaction_code=[code]
[subdomain]: This is the company ID that you created when you signed-up. It will appear on the upper left when logged into CATS.
[transaction_code]: Create and manage transaction codes from within CATS by logging in and clicking on the "Settings" tab, then "User Management" (in the blue bar).
Parameters
Note that parameters can be transmitted through the GET or POST specifications in accordance with HTTP 1.1.

Example using GET: [Base URL]?[parameter]=[value]

Required Parameter Description Type Size
YES keywords Text to search. Boolean/wildcard (*) friendly string 250
  data_type candidate, contact, joborder and company are the available values. Separate multiple values by a comma. To include all values, simply leave this parameter empty. string 128
  is_email If set to Yes, only emails will be searched and standard wildcard/boolean search against all fields will not be performed. You may include multiple emails by separating them with a semi-colon (;) or by sending them as an array through GET or POST. boolean 10
  result Specify how much data you would like returend
minimal (default): data type, id # and title (max_results: 100)
normal: all minimal fields, plus standard fields (max_results: 50)
extended: all fields + extra fields returned (max_results: 50)
string  
  max_results Maximum rows returned, defaults to 20. number  
  offset Used for paging. Specify number of rows to skip. Default is 0. Maximum is 1,000. number  
Example Form
subdomain
transaction_code
keywords

Text to search. Boolean/wildcard (*) friendly
data_type

candidate, contact, joborder and company are the available values. Separate multiple values by a comma. To include all values, simply leave this parameter empty.
is_email

If set to Yes, only emails will be searched and standard wildcard/boolean search against all fields will not be performed. You may include multiple emails by separating them with a semi-colon (;) or by sending them as an array through GET or POST.
result

Specify how much data you would like returend
minimal (default): data type, id # and title (max_results: 100)
normal: all minimal fields, plus standard fields (max_results: 50)
extended: all fields + extra fields returned (max_results: 50)
max_results

Maximum rows returned, defaults to 20.
offset

Used for paging. Specify number of rows to skip. Default is 0. Maximum is 1,000.

Copyright ©2012 CATS Software, Inc. All rights reserved.