Zoho: Get recycle-bin records

Zoho recycleBin.getRecycleBinRecords: arguments, response, policy and SDK examples.

Operation zoho.getrecyclebinrecords

Provider route: GET /crm/v8/settings/recycle_bin. 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["recycleBin"]["getRecycleBinRecords"]>[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.recycleBin.getRecycleBinRecords(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.recycle_bin.get_recycle_bin_records(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed

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)`	object	Alternative	Represents the response payload for a request to retrieve a paginated list of recycle-bin records, containing the records under recycle_bin and pagination metadata under info. Additional keys: not allowed
`$ (anyOf 1).info`	object	Required within parent	Represents pagination and count information for the returned list of recycle-bin records. Additional keys: not allowed
`$ (anyOf 1).info.count`	JSON	Required within parent
`$ (anyOf 1).info.count (anyOf 1)`	integer	Alternative	Represents the total number of records returned on the current page. Format: int32
`$ (anyOf 1).info.count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).info.more_records`	boolean	Required within parent	Indicates whether additional pages of recycle-bin records are available. Possible values: true - More records exist beyond the current page. false - The current page contains the last set of records.
`$ (anyOf 1).info.page`	JSON	Required within parent
`$ (anyOf 1).info.page (anyOf 1)`	integer	Alternative	Represents the current page number in the paginated response. Format: int32
`$ (anyOf 1).info.page (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).info.per_page`	JSON	Required within parent
`$ (anyOf 1).info.per_page (anyOf 1)`	integer	Alternative	Represents the number of records returned on the current page. Format: int32
`$ (anyOf 1).info.per_page (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).recycle_bin`	array	Required within parent	Represents the list of recycle-bin records that match the request, with up to 200 records per page. Maximum items: 200
`$ (anyOf 1).recycle_bin[]`	object	Each item	Represents a single recycle-bin record, including its display name, source module, deletion timestamp, owner, and the user who deleted it. Additional keys: not allowed
`$ (anyOf 1).recycle_bin[].deleted_by`	object	Required within parent	Represents the user who deleted the record. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed
`$ (anyOf 1).recycle_bin[].deleted_by.id`	string	Required within parent	Represents the unique identifier of the user who deleted the record. Maximum length: 100
`$ (anyOf 1).recycle_bin[].deleted_by.name`	string	Required within parent	Represents the display name of the user who deleted the record. Maximum length: 255
`$ (anyOf 1).recycle_bin[].deleted_time`	string	Required within parent	Represents the date and time at which the record was moved to the Recycle Bin, in ISO 8601 format. Format: date-time
`$ (anyOf 1).recycle_bin[].display_name`	string	Required within parent	Represents the display name of the deleted record as it appeared in its source module. Maximum length: 500
`$ (anyOf 1).recycle_bin[].id`	string	Required within parent	Represents the unique identifier of the recycle-bin record. Maximum length: 100
`$ (anyOf 1).recycle_bin[].module`	object	Required within parent	Represents the source module of the deleted record. Refer to the [Get modules](modules.yaml#$.paths./settings/modules.get) endpoint for details. Additional keys: not allowed
`$ (anyOf 1).recycle_bin[].module.api_name`	string	Optional	Represents the API name of the module the record originally belonged to. Maximum length: 100
`$ (anyOf 1).recycle_bin[].module.id`	string	Optional	Represents the unique identifier of the module the record originally belonged to. Maximum length: 100
`$ (anyOf 1).recycle_bin[].owner`	object	Required within parent	Represents the user who owned the record at the time of deletion. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed
`$ (anyOf 1).recycle_bin[].owner.id`	string	Required within parent	Represents the unique identifier of the owning user. Maximum length: 100
`$ (anyOf 1).recycle_bin[].owner.name`	string	Required within parent	Represents the display name of the owning user. Maximum length: 255
`$ (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: zoho.getrecyclebinrecords. Catalog operation: getRecycleBinRecords. 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

Report an issue with this page