[ List of API Functions ] [ CATS Developer Forum ] [ Frequently Asked Questions ]
Example using GET: [Base URL]?[parameter]=[value]
| Required | Parameter | Description | Type | Size |
|---|---|---|---|---|
| keywords | Filter the results by a search string (boolean/wildcard support). | string | ||
| 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) hrxml-30: Returns all information formatted as HR-XML 3.0 (multi-result). |
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 |