List deleted related records

GET/{parentRecordModule}/deleted/{parentRecord}/{relatedList}

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the List deleted related records action (under Related Records).
Fill in the fields below, then reference the result from later steps as {{listDeletedRelatedRecords.response.data}}.

Request

Path parameters

parentRecordModulestringrequired

Specify the API name of the module the parent record belongs to. Refer to the [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html) resource for valid values.

parentRecordstringrequired

Specify the unique numeric identifier of the parent record.

relatedListstringrequired

Specify the API name of the related list containing the records to retrieve or modify. Refer to the [Get Related Lists](https://www.zoho.com/crm/developer/docs/api/v8/related-list-meta.html) resource for valid values.

Query parameters

fieldsstringrequired

Specify the API names of the fields to include in the response as a comma-separated list.

pageinteger (int32)

Specify the page number for paginating results.

Default 1

perPageinteger (int32)

Specify the number of records to return per page. The page and per_page parameter is used to fetch records according to their position in the CRM. Let us 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 and 2) and per_page (200) parameter, the user can fetch all 400 records using 2 API calls. If the requested related list is not present or hidden in a layout, the system will return an INVALID_DATA response.

Default 200

Response

Returns 200 with an object. Read it in later steps with {{listDeletedRelatedRecords.response.data.<field>}}.

dataarray<object>

Array of deleted related record references.

idstringrequired

Unique identifier of the deleted record.

$member_infoobject3 fields

Metadata about the related record.

Moved_To__sstring

Stage value to which the record was moved (stage history / picklist movement).

infoobject

Pagination metadata for deleted records.

pageinteger (int32)required

Current page number.

per_pageinteger (int32)required

Number of records per page.

countinteger (int32)required

Number of records in current response.

more_recordsbooleanrequired

Indicates if more pages are available.

next_page_tokenstring | null

Token to retrieve the next page of results.

page_token_expirystring | null

Expiration timestamp for the page token.

previous_page_tokenstring | null

Token to retrieve the previous page of results.

json

{
  "data": [
    {
      "id": "string",
      "$member_info": {
        "id": "string",
        "Created_Time": "2025-01-01T00:00:00Z",
        "Modified_Time": "2025-01-01T00:00:00Z"
      },
      "Moved_To__s": "string"
    }
  ],
  "info": {
    "page": 0,
    "per_page": 0,
    "count": 0,
    "more_records": false,
    "next_page_token": "string",
    "page_token_expiry": "2025-01-01T00:00:00Z",
    "previous_page_token": "string"
  }
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?