[ List of API Functions ] [ Frequently Asked Questions ]
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 |