Get deleted records from a specified module

GET/{module}/deleted

Use it in a workflow

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

Request

Path parameters

modulestringrequired

Specify the API name of the module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name.

Query parameters

typestring

Specify the category of deleted records to retrieve. Possible values: **all** - Returns both recycled and permanently deleted records. **recycle** - Returns only records in the Recycle Bin. **permanent** - Returns only permanently deleted records.

One ofallrecyclepermanentDefault "all"

pageinteger (int32)

Specify the page number to retrieve. Starts at 1.

per_pageinteger (int32)

Specify the number of records to return per page. Maximum is 200.

Headers

If-Modified-Sincestring (date-time)

Use this header to get the list of records modified after the specified timestamp. The timestamp must be in ISO 8601 format.

Response

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

dataarray<object>

Represents the data value.

idstring (int64)required

Represents the data value.

display_namestring | nullrequired

Represents the data value.

typestringrequired

Represents the data value.

One ofrecyclepermanent

deleted_timestring (date-time)required

Represents the data value.

deleted_byobject | nullrequired2 fields

Represents the data value.

created_byobject | nullrequired2 fields

Represents the data value.

infoobject

Represents the info value.

per_pageinteger (int32)required

Represents the info value.

countinteger (int32)required

Represents the info value.

pageinteger (int32)required

Represents the info value.

more_recordsbooleanrequired

Represents the info value.

json

{
  "data": [
    {
      "id": "string",
      "display_name": "string",
      "type": "recycle",
      "deleted_time": "2025-01-01T00:00:00Z",
      "deleted_by": {
        "name": "string",
        "id": "string"
      },
      "created_by": {
        "name": "string",
        "id": "string"
      }
    }
  ],
  "info": {
    "per_page": 0,
    "count": 0,
    "page": 0,
    "more_records": false
  }
}

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

Was this page helpful?