Get All Records

Purpose

To get a list of records from a module using Widget API.

Request Format

ZOHO.RECRUIT.API.getAllRecords({
"Entity": "{module_api_name}"
});

module_api_name : The API name of the module

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": "Clients"
}).then(function(successResponse) {
    
}, function(errorResponse) {
    
});

Sample Response

Copied{
    "data": [
        {
            "$currency_symbol": "Rs.",
            "No_of_Contacts_Associated": "0",
            "Shipping_State": null,
            "Website": null,
            "Account_Manager": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "Source": null,
            "Last_Activity_Time": "2019-11-13T17:06:38+05:30",
            "Industry": null,
            "Modified_By": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "$process_flow": false,
            "Exchange_Rate": null,
            "Currency": null,
            "Billing_Country": null,
            "Client_Name": "Juice",
            "Contact_Number": null,
            "id": "486812000001224088",
            "$approved": true,
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false,
                "resubmit": false
            },
            "Modified_Time": "2019-11-13T17:06:38+05:30",
            "Billing_Street": null,
            "Last_Mailed_Time": null,
            "Created_Time": "2019-11-13T17:06:38+05:30",
            "$followed": false,
            "$editable": true,
            "Billing_Code": null,
            "Parent_Account": null,
            "About": null,
            "Associated_Tags": [],
            "Shipping_City": null,
            "Shipping_Country": null,
            "Shipping_Code": null,
            "Billing_City": null,
            "Billing_State": null,
            "Created_By": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "Fax": null,
            "Is_Attachment_Present": false,
            "Shipping_Street": null
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}