Get List of Deleted Records
Purpose
To get the list of deleted records.
Endpoints
Request Details
Request URL
{api-domain}/crm/v2/{module_api_name}/deleted
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, and Activities
Header
Authorization: Zoho-oauthtoken 100xx.d92d4xxxxxxxxxxxxx15f52
If-Modified-Since: Use this header to get the list of recently modified records. Example: 2019-07-25T15:26:49+05:30
Scope
scope=ZohoCRM.modules.ALL
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}
Possible module names
leads, accounts, contacts, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, custom, and activities
Possible operation types
ALL - Full access to the record
READ - Get records in the module
Parameters
- typestring, optionalSpecify the type of deleted records you want to retrieve. 
 Possible values -- all: To get the list of all deleted records. This the default value.
- recycle: To get the list of deleted records from recycle bin.
- permanent: To get the list of permanently deleted records.
 
- pageinteger, optionalTo get the list of records from the respective pages. Default value for page is 1. 
 Possible values: Positive integers only
- per_pageinteger, optionalTo get the list of records available per page. The default and the maximum possible value is 200. 
 Possible values: Positive integers only
The page and per_page parameter is used to fetch records according to their position in the Vertical Solutions. Let's assume that the user has to fetch 400 records. The maximum number of records that one can get for an API call is 200. So, for records above the 200th position, they cannot be fetched. By using the page (1, 2) and per_page (200) parameter, the user can fetch all 400 records using 2 API calls.
Sample Request
Copiedcurl "https://zylkercorp.zohoplatform.com/crm/v2/Leads/deleted?type=all"
-X GET
-H "Authorization: Zoho-oauthtoken 100xx.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copied//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters for Get Deleted Records operation */
//can be all/recycle/permanent
await paramInstance.add(ZCRM.Record.Model.GetDeletedRecordsParam.TYPE, "permanent");
await paramInstance.add(ZCRM.Record.Model.GetDeletedRecordsParam.PAGE, 1);
await paramInstance.add(ZCRM.Record.Model.GetDeletedRecordsParam.PER_PAGE, 200);
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
 /* Possible headers for Get Deleted Records operation */
await headerInstance.add(ZCRM.Record.Model.GetDeletedRecordsHeader.IF_MODIFIED_SINCE, new Date('January 15, 2020 10:35:32'));
//Call getDeletedRecords method that takes paramInstance, headerInstance and moduleAPIName as parameter
let response =  await recordOperations.getDeletedRecords(moduleAPIName, paramInstance, headerInstance);Copiedvar listener = 0;
class GetListofDeletedRecords {
	async getDeletedRecords()	{
		var url = "https://zylkercorp.zohoplatform.com/crm/v2/Leads/deleted"
        var parameters = new Map()
        var headers = new Map()
        var token = {
            clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
            redirectUrl:"http://127.0.0.1:5500/redirect.html",
            scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
        }
        var accesstoken = await new GetListofDeletedRecords().getToken(token)
        headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
        headers.set("If-Modified-Since", "2020-05-15T12:00:00+05:30")
        parameters.set("type", "recycle")
        parameters.set("page", "1")
        parameters.set("per_page", "5")
        var requestMethod = "GET"
        var reqBody = null
        var params = "";
        parameters.forEach(function(value, key) {
            if (parameters.has(key)) {
                if (params) {
                    params = params + key + '=' + value + '&';
                }
                else {
                    params = key + '=' + value + '&';
                }
            }
        });
        var apiHeaders = {};
        if(headers) {
            headers.forEach(function(value, key) {
                apiHeaders[key] = value;
            });
        }
        if (params.length > 0){
            url = url + '?' + params.substring(0, params.length - 1);
        }
        var requestObj = {
            uri : url,
            method : requestMethod,
            headers : apiHeaders,
            body : JSON.stringify(reqBody),
            encoding: "utf8",
            allowGetBody : true,
			throwHttpErrors : false
        };
        var result = await new GetListofDeletedRecords().makeAPICall(requestObj);
        console.log(result.status)
        console.log(result.response)
	}
    async getToken(token) {
        if(listener == 0) {
            window.addEventListener("storage", function(reponse) {
                if(reponse.key === "access_token" && (reponse.oldValue != reponse.newValue || reponse.oldValue == null)){
                    location.reload();
                }
                if(reponse.key === "access_token"){
                    sessionStorage.removeItem("__auth_process");
                }
            }, false);
            listener = 1;
            if(sessionStorage.getItem("__auth_process")) {
                sessionStorage.removeItem("__auth_process");
            }
        }
        ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
            var isKeyExists = localStorage.hasOwnProperty(k);
            if(isKeyExists) {
                sessionStorage.setItem(k, localStorage[k]);
            }
            localStorage.removeItem(k);
        });
        var valueInStore = sessionStorage.getItem("access_token");
        var tokenInit = sessionStorage.getItem("__token_init");
        if(tokenInit != null && valueInStore != null && Date.now() >= parseInt(tokenInit) + 59 * 60 * 1000){ // check after 59th minute
            valueInStore = null;
            sessionStorage.removeItem("access_token");
        }
        var auth_process = sessionStorage.getItem("__auth_process");
        if ((valueInStore == null && auth_process == null) || (valueInStore == 'undefined' && (auth_process == null || auth_process == "true"))) {
            var accountsUrl = "https://zylkercorp.zohoplatform.com/developer/docs/vertical-solutions/api/v2/get-deleted-records.html/oauth/v2/auth"
            var clientId;
            var scope;
            var redirectUrl;
            if(token != null) {
                clientId = token.clientId;
                scope = token.scope;
                redirectUrl = token.redirectUrl;
            }
            var fullGrant = sessionStorage.getItem("full_grant");
            var grantedForSession = sessionStorage.getItem("granted_for_session");
            if(sessionStorage.getItem("__token_init") != null && ((fullGrant != null && "true" == full_grant) || (grantedForSession != null && "true" == grantedForSession))) {
                accountsUrl += '/refresh';
            }
            if (clientId && scope) {
                sessionStorage.setItem("__token_init", Date.now());
                sessionStorage.removeItem("access_token");
                sessionStorage.setItem("__auth_process", "true");
                window.open(accountsUrl + "?" + "scope" + "=" + scope + "&"+ "client_id" +"=" + clientId + "&response_type=token&state=zohocrmclient&redirect_uri=" + redirectUrl);
                ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
                    var isKeyExists = localStorage.hasOwnProperty(k);
                    if(isKeyExists){
                        sessionStorage.setItem(k, localStorage[k]);
                    }
                    localStorage.removeItem(k);
                });
                valueInStore = sessionStorage.getItem("access_token");
            }
        }
        if(token != null && valueInStore != 'undefined'){
            token.accessToken = valueInStore;
        }
        return token.accessToken;
    }
    async makeAPICall(requestDetails) {
        return new Promise(function (resolve, reject) {
            var body, xhr, i;
            body = requestDetails.body || null;
            xhr = new XMLHttpRequest();
            xhr.withCredentials = true;
            xhr.open(requestDetails.method, requestDetails.uri, true);
            for (i in requestDetails.headers) {
                xhr.setRequestHeader(i, requestDetails.headers[i]);
            }
            xhr.send(body);
            xhr.onreadystatechange = function() {
                if(xhr.readyState == 4) {
                    resolve(xhr);
                }
            }
        })
    }
}Copiedresponse = invokeurl
[
	url: "https://zylkercorp.zohoplatform.com/crm/v2/Leads/deleted?type=all"
	type: GET
	connection:"crm_oauth_connection"
];
info response;Response JSON keys
- deleted_byJSON objectRepresents the name and ID of the user who deleted the current record. 
- idstringRepresents the unique ID of the deleted record. 
- display_namestringRepresents the display name of the deleted record. 
- typestringRepresents the type of the deleted record. The value can be: all, recycle, or permanent. 
- created_byJSON objectRepresents the name and ID of the user who created the current record. 
- deleted_timestringRepresents the date and time at which the record was deleted. 
Possible Errors
- INVALID_MODULEHTTP 400The module name given seems to be invalid 
 Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.
- INVALID_MODULEHTTP 400The given module is not supported in API 
 Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.
- INVALID_URL_PATTERNHTTP 404Please check if the URL trying to access is a correct one 
 Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.
- OAUTH_SCOPE_MISMATCHHTTP 401Unauthorized 
 Resolution: Client does not have ZohoCRM.modules.{module_name}.READ. Create a new client with valid scope. Refer to scope section above.
- NO_PERMISSIONHTTP 403Permission denied to read 
 Resolution: The user does not have permission to retrieve deleted records. Contact your system administrator.
- INTERNAL_ERRORHTTP 500Internal Server Error 
 Resolution: Unexpected and unhandled exception in the server. Contact support team.
- INVALID_REQUEST_METHODHTTP 400The http request method type is not a valid one 
 Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.
- AUTHORIZATION_FAILEDHTTP 400User does not have sufficient privilege to read records 
 Resolution: The user does not have the permission to retrieve deleted records. Contact your system administrator.
- PATTERN_NOT_MATCHEDHTTP 400Please check whether the input values are correct 
 Resolution: The value specified for the 'type' parameter is incorrect. Refer to parameters section above and specify a valid parameter value.
Sample Response
Copied{
    "data": [
       {
            "deleted_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "id": "410888000000099071",
            "display_name": "Patricia",
            "type": "recycle",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "deleted_time": "2015-06-19T11:19:38+05:30"
        },
       {
            "deleted_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "id": "410888000000094004",
            "display_name": "Patricia",
            "type": "recycle",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "deleted_time": "2015-04-07T17:43:33+05:30"
        },
       {
            "deleted_by": null,
            "id": "410888000000680013",
            "display_name": null,
            "type": "permanent",
            "created_by": null,
            "deleted_time": "2016-10-26T11:44:15+05:30"
        },
       {
            "deleted_by": null,
            "id": "410888000000680009",
            "display_name": null,
            "type": "permanent",
            "created_by": null,
            "deleted_time": "2016-10-26T11:44:15+05:30"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 4,
        "page": 1,
        "more_records": false
    }
}