> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: Record Get Deleted Records

> List the records deleted from a Zoho CRM module, including those still in the recycle bin. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List the records deleted from a Zoho CRM module, including those still in the recycle bin.

> [!NOTE]
>
> Tool ID: `zoho_crm_record_get_deleted_records`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_record_get_deleted_records',
  {
    "module": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_record_get_deleted_records --input '{
  "module": "example"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data": [
      {
        "id": "id_123",
        "type": "recycle",
        "deleted_time": "2026-01-15T12:00:00Z"
      }
    ],
    "info": {
      "per_page": 123,
      "count": 123,
      "page": 123,
      "more_records": true
    }
  }
}
```

Use `deepline describe zoho_crm_record_get_deleted_records --json` for the latest machine-readable contract.

## Input reference

Retrieve the deleted records for the module. This endpoint can retrieve both permanently deleted records and temporarily deleted records from the recycle bin.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.module` | `string` | Yes | — | Specifies the module name Maximum length: 100. |
| `payload.type` | `"all" \| "recycle" \| "permanent"` | No | — | Specifies the type of deleted records to retrieve. Use 'all' to get all deleted records, 'recycle' for records in recycle bin, or 'permanent' for permanently deleted records. Allowed: `all`, `recycle`, `permanent`. Maximum length: 20. |
| `payload.page` | `integer` | No | — | To get the list of records from the respective pages. Default value for page is 1. Format: `int32`. Minimum: 1. |
| `payload.per_page` | `integer` | No | — | To get the list of records available per page. The default and the maximum possible value is 200. Format: `int32`. Minimum: 1. Maximum: 200. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieve the deleted records for the module. This endpoint can retrieve both permanently deleted records and temporarily deleted records from the recycle bin.",
    "properties": {
      "module": {
        "type": "string",
        "description": "Specifies the module name",
        "maxLength": 100
      },
      "type": {
        "type": "string",
        "description": "Specifies the type of deleted records to retrieve. Use 'all' to get all deleted records, 'recycle' for records in recycle bin, or 'permanent' for permanently deleted records.",
        "maxLength": 20,
        "enum": [
          "all",
          "recycle",
          "permanent"
        ]
      },
      "page": {
        "type": "integer",
        "description": "To get the list of records from the respective pages. Default value for page is 1.",
        "minimum": 1,
        "format": "int32"
      },
      "per_page": {
        "type": "integer",
        "description": "To get the list of records available per page. The default and the maximum possible value is 200.",
        "minimum": 1,
        "maximum": 200,
        "format": "int32"
      }
    },
    "required": [
      "module"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Response schema returned when deleted records are successfully retrieved. |
| `result.data.data` | `array` | Yes | — | List of deleted records with their metadata. Maximum items: 200. |
| `result.data.data[].id` | `string` | Yes | — | Unique identifier of the deleted record. Format: `int64`. |
| `result.data.data[].display_name` | `string \| null` | No | — | Display name of the deleted record. Null for permanently deleted records. Maximum length: 255. |
| `result.data.data[].type` | `"recycle" \| "permanent"` | Yes | — | Type of deletion - 'recycle' for records in recycle bin, 'permanent' for permanently deleted records. Allowed: `recycle`, `permanent`. |
| `result.data.data[].deleted_time` | `string` | Yes | — | Timestamp indicating when the record was deleted. Format: `date-time`. |
| `result.data.data[].deleted_by` | `object \| null` | No | — | User who deleted the record. Null for permanently deleted records. |
| `result.data.data[].deleted_by.name` | `string` | No | — | Display name of the user who deleted the record. Maximum length: 255. |
| `result.data.data[].deleted_by.id` | `string` | No | — | Unique identifier of the user who deleted the record. Format: `int64`. |
| `result.data.data[].created_by` | `object \| null` | No | — | User who originally created the record. Null for permanently deleted records. |
| `result.data.data[].created_by.name` | `string` | No | — | Display name of the user who created the record. Maximum length: 255. |
| `result.data.data[].created_by.id` | `string` | No | — | Unique identifier of the user who created the record. Format: `int64`. |
| `result.data.info` | `object` | Yes | — | Pagination information for the deleted records response. |
| `result.data.info.per_page` | `integer` | Yes | — | Number of records per page. Format: `int32`. |
| `result.data.info.count` | `integer` | Yes | — | Number of records returned in the current response. Format: `int32`. |
| `result.data.info.page` | `integer` | Yes | — | Current page number. Format: `int32`. |
| `result.data.info.more_records` | `boolean` | Yes | — | Indicates whether more records are available beyond the current page. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Response schema returned when deleted records are successfully retrieved.",
        "properties": {
          "data": {
            "type": "array",
            "description": "List of deleted records with their metadata.",
            "maxItems": 200,
            "items": {
              "type": "object",
              "description": "Deleted record object containing information about a single deleted record.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Unique identifier of the deleted record.",
                  "format": "int64"
                },
                "display_name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Display name of the deleted record. Null for permanently deleted records.",
                  "maxLength": 255
                },
                "type": {
                  "type": "string",
                  "description": "Type of deletion - 'recycle' for records in recycle bin, 'permanent' for permanently deleted records.",
                  "enum": [
                    "recycle",
                    "permanent"
                  ]
                },
                "deleted_time": {
                  "type": "string",
                  "description": "Timestamp indicating when the record was deleted.",
                  "format": "date-time"
                },
                "deleted_by": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "User who deleted the record. Null for permanently deleted records.",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Display name of the user who deleted the record.",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique identifier of the user who deleted the record.",
                      "format": "int64"
                    }
                  },
                  "additionalProperties": false
                },
                "created_by": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "User who originally created the record. Null for permanently deleted records.",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Display name of the user who created the record.",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique identifier of the user who created the record.",
                      "format": "int64"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "required": [
                "id",
                "type",
                "deleted_time"
              ],
              "additionalProperties": true
            }
          },
          "info": {
            "type": "object",
            "description": "Pagination information for the deleted records response.",
            "properties": {
              "per_page": {
                "type": "integer",
                "description": "Number of records per page.",
                "format": "int32"
              },
              "count": {
                "type": "integer",
                "description": "Number of records returned in the current response.",
                "format": "int32"
              },
              "page": {
                "type": "integer",
                "description": "Current page number.",
                "format": "int32"
              },
              "more_records": {
                "type": "boolean",
                "description": "Indicates whether more records are available beyond the current page."
              }
            },
            "required": [
              "per_page",
              "count",
              "page",
              "more_records"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "data",
          "info"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.