getAllRecords
Promise: To get all the available records from a specified module via widget APIs.
Request Format
ZOHO.RECRUIT.API.getAllRecords({Entity:"module_api_name", fields:"field1, field2, field3"})
module_api_name - The API name of the module.
field1, field2, field3 - Comma separated field labels.
Parameters
| Parameter Name | Data Type | Description | Possible Values |
|---|---|---|---|
| fields (optional) | String | To list all the module records with respect to fields | Multiple field API names, comma-separated. For example Last_Name, Email |
| sort_order (optional) | String | To sort the available list of records in either ascending or descending order | asc - ascending order desc - descending order |
| sort_by (optional) | String | To sort the available list of records based on the given field | Field API name Example: Email |
| converted (optional) | String | To get the list of converted records. The default value is false | true - get only converted records false - get only non-converted records both - get all records |
| approved (optional) | String | To get the list of approved records. The default value is true. | true - get only approved records false - get only records that are not approved both - get all records |
| page (optional) | Integer | To get the list of records from the respective pages. The default value for the page is 1. | Positive Integer values only |
| per_page (optional) | Integer | To get the list of records available per page. The default value for the page is 200. | Positive Integer values only |
| cvid (optional) | Integer | To get the list of records based on custom views | {custom_view_id} |
| territory_id (optional) | Integer | To get the list of records based on the territory | {territory_id} |
| include_child (optional) | Boolean | To include records from the child territories. True includes child territory records. False does not include child territory records. The default value is false. | true or false |
Sample Request
CopiedZOHO.RECRUIT.API.getAllRecords({Entity:"Candidates", per_page:"5", page: "1", fields:"Last_Name, First_Name, Candidate_ID", sort_by:"asc"})
.then(function(successResponse)
{
},
function(failureResponse)
{
});