Retrieve the paginated list of trashed configurations with search, sort and filter options

Returns a paginated list of all configurations that have been moved to trash for the requesting user. Supports pagination (_PN) and search (SEARCH_COLUMN / SEARCH_VALUE). Each row includes the deleted-by user, deleted time and the collectionId, which can be used in the trash restore / permanent delete APIs.

Endpoints

get /dcapi/configuration/viewData/trashView

Copy full URL

Request URL

https://{serverurl}/dcapi/configuration/viewData/trashView

Scope

DesktopCentralCloud.Common.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/configurationMickeyViews.v1+jsonCopied!

- Query Parameters

_PNstringOptional

Page number to fetch (1-based). Defaults to 1.

SEARCH_COLUMNstringOptional

Column alias on which the search should be applied. Searches against the configuration name (Collection.COLLECTION_NAME). Must be supplied together with SEARCH_VALUE.

SEARCH_VALUEstringOptional

Substring to search for within the configuration name. Case-insensitive.

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomains/dcapi/configuration/viewData/trashView \
  --header 'Accept: application/configurationMickeyViews.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/dcapi/configuration/viewData/trashView"))
        .header("Accept", "application/configurationMickeyViews.v1+json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

headers = {
    'Accept': "application/configurationMickeyViews.v1+json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/dcapi/configuration/viewData/trashView", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/configurationMickeyViews.v1+json");

    response = invokeUrl
    [
        url: "https://appDomains/dcapi/configuration/viewData/trashView"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/configurationMickeyViews.v1+json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/dcapi/configuration/viewData/trashView' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

statusstring

Result of the trash-view fetch — 'success' on success, 'failure' on internal error.

messageResponseJSON Array

Array of trashed configuration row objects matching the applied search/sort, paginated by _PN.

Show Sub-Attributes

JSON Object

Show Sub-Attributes

collection_idstring

Unique configuration (collection) ID returned as a stringified long. Use this value in the trash restore / permanent delete APIs.

customer_idstring

Customer (org) ID owning this trashed configuration. Relevant for MSP setups.

collection_namestring

Display name of the configuration at the time it was trashed.

collection_name_transformstring

Display-formatted variant of collection_name (same value).

config_idstring

Configuration-type ID (e.g., 117 = Message Box, 121 = Custom Script).

config_typestring

Target type code: '1' = User configuration, '2' = Computer configuration.

labelstring

i18n key of the configuration-type label (e.g., 'dc.conf.conf_param.Message_Box'). Use label_transform for the localised text.

label_transformstring

Localised configuration-type label suitable for display.

small_image_namestring

Relative path to the small icon representing the configuration type (used by the UI).

is_single_configstring

'true' when this is a Single Config (collectionType=1), 'false' when it is a Collection (collectionType=2).

status_idstring

Last-known numeric status code of the collection before it was trashed (e.g., '4' = Executed).

statuslabelstring

i18n key of the last-known collection status (e.g., 'dc.db.config.status.executed'). Use statuslabel_transform for the localised text.

statuslabel_transformstring

Localised, display-ready last-known status label (e.g., 'Executed', 'Deployed', 'Suspended').

statusimagestring

Relative path to the icon representing the last-known status.

total_target_countstring

Total number of resources targeted by this configuration before it was trashed. null when no targets were computed.

total_target_count_transformstring

Display-formatted total-target count; '--' when null.

yet_to_apply_countstring

Targets where the configuration had not yet been applied. null when not computed.

yet_to_apply_count_transformstring

Display variant of yet_to_apply_count; '--' when null.

success_countstring

Targets where the configuration was successfully applied. null when not computed.

success_count_transformstring

Display variant of success_count; '--' when null.

failed_countstring

Targets where the configuration application failed. null when not computed.

failed_count_transformstring

Display variant of failed_count; '--' when null.

retry_inprogress_countstring

Targets being retried after an earlier failure. null when not computed.

retry_inprogress_count_transformstring

Display variant of retry_inprogress_count; '--' when null.

not_applicable_countstring

Targets where the configuration was not applicable. null when not computed.

not_applicable_count_transformstring

Display variant of not_applicable_count; '--' when null.

status_count_descstring

Human-readable summary of per-status counts (e.g., 'Total Targets ( 1 ), Success ( 1 )'). null when no summary computed.

status_count_desc_transformstring

Display variant of status_count_desc; '--' when null.

os_platform_idstring

Platform code: '1' = Windows, '2' = Mac, '3' = Linux.

os_platform_namestring

Platform name — Windows, Mac, or Linux.

os_platform_name_transformstring

Display variant of os_platform_name.

user_idstring

ID of the technician who created the configuration.

first_namestring

first_name_transformstring

Display variant of first_name (PII-masked when applicable).

modifieduser_user_idstring

ID of the technician who last modified the configuration before it was trashed.

modifieduser_first_namestring

collection_creation_timestring

Creation timestamp as Unix epoch milliseconds (string).

collection_modified_timestring

Last-modified timestamp (typically equal to deleted_time for trashed configurations) as Unix epoch milliseconds (string).

collection_modified_time_transformstring

Human-readable last-modified timestamp (e.g., 'Apr 28, 2026 10:50 AM').

is_collection_deletedstring

Always 'true' for rows returned by the trash view.

deletedbystring

deletedby_transformstring

Display variant of deletedby (PII-masked when applicable).

deleted_timestring

Timestamp when the configuration was moved to trash, as Unix epoch milliseconds (string).

deleted_time_transformstring

Human-readable deleted-time (e.g., 'Apr 28, 2026 10:50 AM').

dc_user_idstring

Internal DC user reference (for user-targeted configurations).

created_fromstring

Source indicator for the configuration's origin (e.g., template ID it was created from). null when created from scratch.

show_in_viewstring

'true' when the row should be shown in the user's current view scope; 'false' when filtered out by scope but still returned.

metadataJSON Object

Pagination metadata for the response.

Show Sub-Attributes

pagestring

Current page number (1-based).

limitstring

Number of records per page applied to this response.

totalRecordsstring

Total number of trashed configurations matching the applied filters across all pages.

totalPagesstring

Total number of pages available based on the page limit.

LinksJSON Object

Hypermedia navigation links for first / previous / next / last pages.

Show Sub-Attributes

firststring

URL of the first page of results.

previousstring

URL of the previous page of results. Omitted on the first page.

nextstring

URL of the next page of results. Omitted on the last page.

laststring

URL of the last page of results.

- HTTP code 400

Response Body - application/json

JSON Object

Hide Sub-Attributes

Errorstring

Validation error — typically input-processing failure or pagination out of range. _PN must be 1-100000.

- HTTP code 401

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 500

Response Body - application/json

JSON Object

Hide Sub-Attributes

error_codestring

50001: internal server error code indicating unexpected exception in the service layer

error_descriptionstring

Internal server error. Contact administrator.

Possible Response Codes

200HTTP code

400HTTP code

401HTTP code

500HTTP code

Sample Response: HTTP 200

First page of trashed configurations sorted by last-modified time descending (default)

Copied!

  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 1,
    "messageResponse": [
      {
        "total_target_count": "1",
        "modifieduser_user_id": "9502000000121919",
        "status_count_desc_transform": "Total Targets ( 1 ), Success ( 1 )",
        "collection_collection_id": "9502000000139889",
        "dcuserscollectionmapping_collection_id": "9502000000139889",
        "total_target_count_transform": "1",
        "os_platform_name": "Windows",
        "retry_inprogress_count_transform": "0",
        "status_id": "4",
        "collection_modified_time": "1777353655231",
        "config_data_id": "9502000000139891",
        "deletedby_transform": "testuser1",
        "config_type": "1",
        "statuslabel_transform": "Executed",
        "os_platform_id": "1",
        "os_platform_name_transform": "Windows",
        "is_collection_deleted": "true",
        "modifieduser_first_name": "testuser1",
        "deletedby": "testuser1",
        "collection_collection_id_transform": "9502000000139919",
        "success_count_transform": "1",
        "label_transform": "dc.conf.conf_param.Message_Box",
        "retry_inprogress_count": "0",
        "config_id": "117",
        "user_id": "9502000000121919",
        "small_image_name": "images/alert.png",
        "yet_to_apply_count_transform": "0",
        "deleted_time": "1777353655231",
        "collection_name": "MyConfiguration20",
        "dc_user_id": "9502000000121919",
        "show_in_view": "true",
        "collection_name_transform": "MyConfiguration21",
        "statusimage": "images/config_status_executed.png",
        "collection_platform_id": "1",
        "statuslabel": "dc.db.config.status.executed",
        "collection_id": "9502000000139889",
        "first_name_transform": "testuser1",
        "cfgdatatocollection_collection_id": "9502000000139889",
        "collection_status": "4",
        "deleted_time_transform": "Apr 28, 2026 10:50 AM",
        "not_applicable_count": "0",
        "not_applicable_count_transform": "0",
        "first_name": "testuser1",
        "failed_count_transform": "0",
        "collection_creation_time": "1776757701089",
        "is_single_config": "true",
        "collection_modified_time_transform": "Apr 28, 2026 10:50 AM",
        "success_count": "1",
        "label": "dc.conf.conf_param.Message_Box",
        "status_count_desc": "Total Targets ( 1 ), Success ( 1 )",
        "yet_to_apply_count": "0",
        "failed_count": "0",
        "customer_id": "9502000000121939",
        "created_from": null
      }
    ],
    "totalPages": 1,
    "Links": {
      "last": "/dcapi/configuration/viewData/trashView?_PN=1",
      "first": "/dcapi/configuration/viewData/trashView?_PN=1"
    },
    "status": "success"
  }

▼ Show full

No configurations are currently in the trash

Copied!

  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 0,
    "messageResponse": [],
    "totalPages": 0,
    "Links": {
      "last": "/dcapi/configuration/viewData/trashView?_PN=1",
      "first": "/dcapi/configuration/viewData/trashView?_PN=1"
    },
    "status": "success"
  }

▼ Show full

Sample Response: HTTP 400

_PN outside the allowed range

Copied!

  {
    "Error": "PageNumber should not be greater than 100000 "
  }

▼ Show full

Failure while parsing the query parameters

Copied!

  {
    "Error": "Error in Input Processing"
  }

▼ Show full

Sample Response: HTTP 401

User lacks the required read role for the trash view

Copied!

  {
    "error_description": "Access denied - You are not allowed to access the requested resource.",
    "error_code": "UAC_UNAUTHORIZED"
  }

▼ Show full

Sample Response: HTTP 500

Unexpected failure while resolving the trash view data

Copied!

  {
    "error_description": "Internal server error. Contact administrator.",
    "error_code": "50001"
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.