Zoho: Get deleted records from a specified module

← Record operations · Get started

Operation zoho.getdeletedrecords

Provider route: GET /crm/v8/{module}/deleted. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["record"]["getDeletedRecords"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.record.getDeletedRecords(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.record.get_deleted_records(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.module	string	Required within parent	Maximum length: 25
query	object	Optional	Additional keys: not allowed
query.type	string	Optional	Default: all One of: all, recycle, permanent Maximum length: 20
query.page	integer	Optional	Format: int32 Minimum: 1
query.per_page	integer	Optional	Format: int32 Maximum: 200 Minimum: 1
headers	object	Optional	Additional keys: not allowed
headers.If-Modified-Since	string	Optional	Format: date-time Maximum length: 100

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Get deleted records from a specified module — response body — data, info
$ (anyOf 2)	null	Alternative

Referenced models: Get deleted records from a specified module — response body — data, info

Schemas

Get deleted records from a specified module — response body — data, info

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response schema for the deleted records success operation. Additional keys: not allowed
data	array	Required within parent	Represents the data value. Maximum items: 200 Minimum items: 1
data[]	object	Each item	Represents a single item in the DeletedRecordsSuccessResponse array. Additional keys: not allowed
data[].created_by	JSON	Required within parent
data[].created_by (anyOf 1)	object	Alternative	Represents the data value. Additional keys: not allowed
data[].created_by (anyOf 1).id	string	Required within parent	Represents the data value. Format: int64
data[].created_by (anyOf 1).name	string	Required within parent	Represents the data value. Maximum length: 101
data[].created_by (anyOf 2)	null	Alternative	Represents the data value. Additional keys: not allowed
data[].created_by (anyOf 2).id	string	Required within parent	Represents the data value. Format: int64
data[].created_by (anyOf 2).name	string	Required within parent	Represents the data value. Maximum length: 101
data[].deleted_by	JSON	Required within parent
data[].deleted_by (anyOf 1)	object	Alternative	Represents the data value. Additional keys: not allowed
data[].deleted_by (anyOf 1).id	string	Required within parent	Represents the data value. Format: int64
data[].deleted_by (anyOf 1).name	string	Required within parent	Represents the data value. Maximum length: 255
data[].deleted_by (anyOf 2)	null	Alternative	Represents the data value. Additional keys: not allowed
data[].deleted_by (anyOf 2).id	string	Required within parent	Represents the data value. Format: int64
data[].deleted_by (anyOf 2).name	string	Required within parent	Represents the data value. Maximum length: 255
data[].deleted_time	string	Required within parent	Represents the data value. Format: date-time
data[].display_name	JSON	Required within parent
data[].display_name (anyOf 1)	string	Alternative	Represents the data value. Maximum length: 255
data[].display_name (anyOf 2)	null	Alternative	Represents the data value. Maximum length: 255
data[].id	string	Required within parent	Represents the data value. Format: int64
data[].type	string	Required within parent	Represents the data value. Known values: recycle, permanent
info	object	Required within parent	Represents the info value. Additional keys: not allowed
info.count	JSON	Required within parent
info.count (anyOf 1)	integer	Alternative	Represents the info value. Format: int32
info.count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
info.more_records	boolean	Required within parent	Represents the info value.
info.page	JSON	Required within parent
info.page (anyOf 1)	integer	Alternative	Represents the info value. Format: int32
info.page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
info.per_page	JSON	Required within parent
info.per_page (anyOf 1)	integer	Alternative	Represents the info value. Format: int32
info.per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: zoho.getdeletedrecords. Catalog operation: getDeletedRecords. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source