Zoho: List deleted related records
Zoho relatedRecords.getDeletedRelatedRecord: arguments, response, policy and SDK examples.
← Related records operations · Get started
Operation zoho.getdeletedrelatedrecord
Provider route: GET /crm/v8/{parentRecordModule}/deleted/{parentRecord}/{relatedList}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["relatedRecords"]["getDeletedRelatedRecord"]>[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.relatedRecords.getDeletedRelatedRecord(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.related_records.get_deleted_related_record(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.parentRecordModule | string | Required within parent | Maximum length: 100 Pattern: ^[A-Za-z_][A-Za-z0-9_]*$ |
path.parentRecord | string | Required within parent | Maximum length: 20 Pattern: ^[0-9]+$ |
path.relatedList | string | Required within parent | Maximum length: 100 Pattern: ^[A-Za-z_][A-Za-z0-9_]*$ |
query | object | Required within parent | Additional keys: not allowed |
query.fields | string | Required within parent | Maximum length: 1000 Pattern: ^[A-Za-z_][A-Za-z0-9_](,[A-Za-z_][A-Za-z0-9_])*$ |
query.page | integer | Optional | Default: 1 Format: int32 Maximum: 10000 Minimum: 1 |
query.perPage | integer | Optional | Default: 200 Format: int32 Maximum: 200 Minimum: 1 |
Response
Section titled “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 for deleted related records, including the record references and pagination metadata. Additional keys: not allowed |
$ (anyOf 1).data | array | Required within parent | Array of deleted related record references. Maximum items: 200 |
$ (anyOf 1).data[] | object | Each item | Represents a deleted related record reference, including its identifier and associated metadata. Additional keys: allowed |
$ (anyOf 1).data[].$member_info | object | Optional | Metadata about the related record. Additional keys: not allowed |
$ (anyOf 1).data[].$member_info.Created_Time | string | Optional | Represents the creation date and time of the record. Format: date-time |
$ (anyOf 1).data[].$member_info.Modified_Time | string | Optional | Timestamp when the record was last modified. Format: date-time |
$ (anyOf 1).data[].$member_info.id | string | Optional | ID of the member info. Maximum length: 20 Pattern: ^[0-9]+$ |
$ (anyOf 1).data[].Moved_To__s | string | Optional | Stage value to which the record was moved (stage history / picklist movement). Maximum length: 255 |
$ (anyOf 1).data[].id | string | Required within parent | Unique identifier of the deleted record. Maximum length: 20 Pattern: ^[0-9]+$ |
$ (anyOf 1).info | object | Required within parent | Pagination metadata for deleted records. Additional keys: not allowed |
$ (anyOf 1).info.count | JSON | Required within parent | |
$ (anyOf 1).info.count (anyOf 1) | integer | Alternative | Number of records in current response. Format: int32 Minimum: 0 |
$ (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 if more pages are available. |
$ (anyOf 1).info.next_page_token | JSON | Optional | |
$ (anyOf 1).info.next_page_token (anyOf 1) | string | Alternative | Token to retrieve the next page of results. Maximum length: 500 |
$ (anyOf 1).info.next_page_token (anyOf 2) | null | Alternative | Token to retrieve the next page of results. Maximum length: 500 |
$ (anyOf 1).info.page | JSON | Required within parent | |
$ (anyOf 1).info.page (anyOf 1) | integer | Alternative | Current page number. Format: int32 Minimum: 1 |
$ (anyOf 1).info.page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).info.page_token_expiry | JSON | Optional | |
$ (anyOf 1).info.page_token_expiry (anyOf 1) | string | Alternative | Expiration timestamp for the page token. Format: date-time |
$ (anyOf 1).info.page_token_expiry (anyOf 2) | null | Alternative | Expiration timestamp for the page token. Format: date-time |
$ (anyOf 1).info.per_page | JSON | Required within parent | |
$ (anyOf 1).info.per_page (anyOf 1) | integer | Alternative | Number of records per page. Format: int32 Maximum: 200 Minimum: 1 |
$ (anyOf 1).info.per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).info.previous_page_token | JSON | Optional | |
$ (anyOf 1).info.previous_page_token (anyOf 1) | string | Alternative | Token to retrieve the previous page of results. Maximum length: 500 |
$ (anyOf 1).info.previous_page_token (anyOf 2) | null | Alternative | Token to retrieve the previous page of results. Maximum length: 500 |
$ (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getdeletedrelatedrecord. Catalog operation: getDeletedRelatedRecord. 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]