get_candidates

[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).

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
	search	Filter by a search string.	string	255
	rows_per_page	Number of rows/records returned for the request. Maximum of 50 may be returned.	number
	page_number	Sets the offset page number to scroll to. Maximum of 25 (if you need further, use filters or search to better limit the results to a manageable number).	number
	show_columns	Instead of returning the data results, return a list of the available columns that can be used in filters and to format the result data. Defaults to 'no'.	boolean
	sort	id for a column to sort by. Retrieve id options from show_columns.	string	128
	sort_direction	desc or asc.	string	10
	display_column	One or more id values from show_columns to indicate which columns to display in the results.	string
	filter	Column-specific filter in the format: 'ID;OPERATOR;SEARCH'. Id can be obtained from show_columns. Operators are lessthan, greaterthan, equalto, contains, doesnotcontain, doesnotequal, nearzipcode, datebetween, between, isempty, or isexactly (operators may not be available for all fields. The search includes the boolean/wildcard string to search against the column using the specified operator.	string
	list	List ID of an existing static or dynamic list. Prefix with type, for example: dynamic:1234.	string
	export_csv	If you would prefer a complete result set (as opposed to paginated results in XML), setting this will build a CSV file with values for every row. The file will be comma separated using double quotes as the escape character.	boolean

subdomain

transaction_code

search

Filter by a search string.

rows_per_page

Number of rows/records returned for the request. Maximum of 50 may be returned.

page_number

Sets the offset page number to scroll to. Maximum of 25 (if you need further, use filters or search to better limit the results to a manageable number).

show_columns

Instead of returning the data results, return a list of the available columns that can be used in filters and to format the result data. Defaults to 'no'.

sort

id for a column to sort by. Retrieve id options from show_columns.

sort_direction

desc or asc.

display_column

One or more id values from show_columns to indicate which columns to display in the results.

filter

Column-specific filter in the format: 'ID;OPERATOR;SEARCH'. Id can be obtained from show_columns. Operators are lessthan, greaterthan, equalto, contains, doesnotcontain, doesnotequal, nearzipcode, datebetween, between, isempty, or isexactly (operators may not be available for all fields. The search includes the boolean/wildcard string to search against the column using the specified operator.

list

List ID of an existing static or dynamic list. Prefix with type, for example: dynamic:1234.

export_csv

If you would prefer a complete result set (as opposed to paginated results in XML), setting this will build a CSV file with values for every row. The file will be comma separated using double quotes as the escape character.