List of deleted records

Retrieve a list of deleted records that have been deleted from Bigin.

Endpoints

Request URL

{api-domain}/bigin/v2/{module_api_name}/deleted

Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

For US, https://www.zohoapis.com
For EU, https://www.zohoapis.eu
For AU, https://www.zohoapis.com.au
For IN, https://www.zohoapis.in
For CN, https://www.zohoapis.com.cn
For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.

Authorization

For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with any one of the following scopes:

ZohoBigin.modules.ALL
ZohoBigin.modules.{module_name}.ALL
ZohoBigin.modules.{module_name}.READ

In the above scope, replace {module_name} with the module from which you want to retrieve the list of deleted records. The possible modules include pipelines, contacts, accounts (companies in Bigin), products, calls, events, and tasks.

Request parameters

The available request parameters are given below:

Path parameters

module_api_name stringRequired

The API name of the module. The possible modules for this endpoint and their API name are given below:

Module	API Name
Contacts	Contacts
Pipelines	Pipelines
Companies	Accounts
Products	Products
Tasks	Tasks
Events	Events
Calls	Calls

Query parameters

type stringOptional

Determines the type of deleted records to retrieve. The type values include:

Value	Value Description
all	Retreives all deleted records. This is the default value.
recycle	Retrieves deleted records from the recycle bin.
permanent	Retreives deleted records that have been permanently deleted.

page integerOptional

Represents the page index. This parameter lists the records from the given page index. The default value is 1.

per_page integerOptional

Represents the number of records per page index. The default value is 200, which means up to 200 records can be retrieved per page index.

Notes:

The page and per_page parameters are utilized when you want to fetch more than 200 records. Since the maximum number of records per API call is 200, fetching records beyond the 200th position is not possible in a single call. However, by making two API calls with page values of 1 and 2 and a per_page value of 200, all 400 records can be retrieved.
This API allows fetching records that are temporarily deleted or moved to recycle bin within 60 days of deletion and permanently deleted records within 120 days of deletion.

Sample request

Curl Deluge

Copiedcurl "https://www.zohoapis.com/bigin/v2/Pipelines/deleted?type=all" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Pipelines/deleted?type=all"
	type: GET
	connection:"connection_link_name"
];
info response;

Response object

The response object provides the list of deleted records.

Possible error codes

The response of this resource includes HTTP status and error codes.

Sample response

Copied{
    "data": [
        {
            "deleted_by": {
                "name": "Zylker Travels",
                "id": "2034020000000457001"
            },
            "id": "2034020000000644085",
            "display_name": "European Capitals Tour",
            "type": "recycle",
            "created_by": {
                "name": "Zylker Travels",
                "id": "2034020000000457001"
            },
            "deleted_time": "2023-07-14T19:14:33+05:30"
        },
        {
            "deleted_by": {
                "name": "Zylker Travels",
                "id": "2034020000000457001"
            },
            "id": "2034020000000489059",
            "display_name": "Wellness Retreat Package",
            "type": "recycle",
            "created_by": {
                "name": "Zylker Travels",
                "id": "2034020000000457001"
            },
            "deleted_time": "2023-07-14T19:12:31+05:30"
        },
        {
            "deleted_by": {
                "name": "Zylker Travels",
                "id": "2034020000000457001"
            },
            "id": "2034020000000683003",
            "display_name": "Wildlife Safari Promotion",
            "type": "recycle",
            "created_by": {
                "name": "Zylker Travels",
                "id": "2034020000000457001"
            },
            "deleted_time": "2023-07-14T19:12:05+05:30"
        },
        {
            "deleted_by": {
                "name": "Zylker Travels",
                "id": "2034020000000457001"
            },
            "id": "2034020000000478069",
            "display_name": "Beach Vacation Package",
            "type": "recycle",
            "created_by": {
                "name": "John Smith",
                "id": "2034020000000472114"
            },
            "deleted_time": "2023-07-11T16:41:32+05:30"
        },
        {
            "deleted_by": {
                "name": "Zylker Travels",
                "id": "2034020000000457001"
            },
            "id": "2034020000000459524",
            "display_name": "Zylker Yearly Subscription",
            "type": "recycle",
            "created_by": {
                "name": "Zylker Travels",
                "id": "2034020000000457001"
            },
            "deleted_time": "2023-07-11T16:41:32+05:30"
        },
        {
            "deleted_by": null,
            "id": "2034020000000478103",
            "display_name": null,
            "type": "permanent",
            "created_by": null,
            "deleted_time": "2023-07-14T19:15:11+05:30"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 6,
        "page": 1,
        "more_records": false
    }
}