Get List of Deleted Records

Purpose

To get the list of deleted records.

Request URL

https://recruit.zoho.com/recruit/v2/{module_api_name}/deleted

module_api_name - The API name of the module

Modules supported in Get List of Records are supported here.

Request Method

GET

Scope

scope=ZohoRecruit.modules.all
(or)
scope=ZohoRecruit.modules.{module_name}.{operation_type}

Possible module names	Possible operation types
candidate, application, jobopening, interview, client, contact, department, task, event, vendor, campaign, referral, submission and custommodule	ALL - Full access to the record READ - Get records in the module

Request Headers

Header Name	Data Type	Description	Example
If-Modified-Since(optional)	DateTime(ISO 8601 format)	To get the list of recently deleted records	2019-07-25T15:26:49+05:30

Parameters

Parameter Name	Data Type	Description
module (mandatory)	String	Specify the module API name
type	String	All To get the list of all deleted records Recycle To get the list of deleted records from recycle bin Permanent To get the list of permanently deleted records
page (optional)	Integer	To get the list of records from the respective pages. The default value for a page is 1.
per_page (optional)	Integer	To get the list of records available per page. The default value for a page is 200.

Note:

The page and per_page parameter is used to fetch records according to their position in Recruit. 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, 3, and 4) and per_page (100) parameters, the user can fetch all 400 records using 4 API calls.

Possible Errors

HTTP Status	Error Code	Message	Reason
400	INVALID_DATA	Invalid data	Invalid type param value given.

Sample Request

Copiedcurl "https://recruit.zoho.com/recruit/v2/Candidates/deleted"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Sample Response

Copied{
    "data": [
        {
            "deleted_by": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "id": "486812000001660095",
            "display_name": "Sagar Samuel Jacky",
            "type": "recycle",
            "created_by": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "deleted_time": "2020-08-21T16:18:00+05:30"
        },
        {
            "deleted_by": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "id": "486812000001660087",
            "display_name": "Sagar Alias Jacky",
            "type": "recycle",
            "created_by": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "deleted_time": "2020-08-21T16:14:00+05:30"
        },
        {
            "deleted_by": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "id": "486812000001336264",
            "display_name": "Ismail",
            "type": "recycle",
            "created_by": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "deleted_time": "2020-08-21T16:14:00+05:30"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 3,
        "page": 1,
        "more_records": false
    }
}