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

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns a paginated list of all configurations visible to the requesting user. Supports pagination (_PN), search (SEARCH_COLUMN / SEARCH_VALUE) and view-specific filters by platform, status, type and config category.

Endpoints

Request URL

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

Scope

DesktopCentralCloud.Common.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/configurationMickeyViews.v1+jsonapplication/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.

platFormIDstringOptional

Filter by target OS platform. 1 = Windows, 2 = Mac, 3 = Linux.

configurationStatusstringOptional

Filter by configuration status. Common values: deployed, suspended, draft, trashed, yetToDeploy, expired.

configurationTypestringOptional

Filter by target type. 1 = User configuration, 2 = Computer configuration.

categorylongOptional

Filter by configuration-type ID (config-id). The ID identifies the specific configuration category — for example 121 = Custom Script.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/configuration/viewData/configurationsView \
  --header 'Accept: application/configurationMickeyViews.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
statusstring

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

messageResponseJSON Array

Array of configuration row objects matching the applied filters/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 subsequent configuration-management APIs (Get Configuration Details, Suspend, Resume, Move To Trash, etc.).

customer_idstring

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

collection_namestring

Display name of the configuration.

collection_name_transformstring

Display-formatted variant of collection_name (same value).

config_idstring

Configuration-type ID (e.g., 128 = Scheduler, 121 = Custom Script). Used by the 'category' query filter.

config_typestring

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

config_type_transformstring

Display variant of config_type.

labelstring

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

label_transformstring

Localised configuration-type label suitable for display (e.g., 'Scheduler', 'Custom Script').

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

Numeric status code of the collection (e.g., '9' = Draft).

statuslabelstring

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

statuslabel_transformstring

Localised, display-ready status label (e.g., 'Draft', 'Deployed', 'Suspended').

statusimagestring

Relative path to the icon representing the current status.

total_target_countstring

Total number of resources targeted by this configuration. null when no targets are computed yet.

total_target_count_transformstring

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

yet_to_apply_countstring

Targets where the configuration has 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 currently 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 is not applicable (e.g., OS mismatch). 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., 'Success: 23, Failed: 2, Yet to Apply: 5'). 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

Login/display name of the technician who created the configuration.

first_name_transformstring

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

modifieduser_user_idstring

ID of the technician who last modified the configuration.

modifieduser_first_namestring

Login/display name of the technician who last modified the configuration.

modifieduser_first_name_transformstring

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

collection_creation_timestring

Creation timestamp as Unix epoch milliseconds (string).

collection_creation_time_transformstring

Human-readable creation timestamp (e.g., 'Apr 27, 2026 02:36 PM').

collection_modified_timestring

Last-modified timestamp as Unix epoch milliseconds (string).

collection_modified_time_transformstring

Human-readable last-modified timestamp (e.g., 'Apr 27, 2026 02:36 PM').

is_collection_deletedstring

'true' when the configuration has been moved to trash; 'false' otherwise.

deletedbystring

Login name of the technician who moved the configuration to trash. null when not deleted.

deleted_timestring

Timestamp when the configuration was moved to trash (epoch ms as string). null when not deleted.

dc_user_idstring

Internal DC user reference (typically null for non-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 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 sorted by last-modified time (default)

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 1,
    "messageResponse": [
      {
        "total_target_count": null,
        "collection_creation_time_transform": "Apr 27, 2026 02:36 PM",
        "modifieduser_user_id": "9502000000121919",
        "status_count_desc_transform": "--",
        "collection_collection_id": "9502000000143001",
        "dcuserscollectionmapping_collection_id": "9502000000143001",
        "total_target_count_transform": "--",
        "os_platform_name": "Windows",
        "retry_inprogress_count_transform": "--",
        "status_id": "9",
        "collection_modified_time": "1777280770860",
        "config_data_id": "9502000000143003",
        "config_type_transform": "1",
        "config_type": "1",
        "statuslabel_transform": "Draft",
        "os_platform_id": "1",
        "os_platform_name_transform": "Windows",
        "is_collection_deleted": "false",
        "modifieduser_first_name": "testuser1",
        "deletedby": null,
        "collection_collection_id_transform": "9502000000143001",
        "success_count_transform": "--",
        "label_transform": "dc.common.SCHEDULER",
        "retry_inprogress_count": null,
        "config_id": "128",
        "user_id": "9502000000121919",
        "small_image_name": "images/scheduler.gif",
        "yet_to_apply_count_transform": "--",
        "deleted_time": null,
        "collection_name": "MyConfiguration48",
        "dc_user_id": null,
        "show_in_view": "true",
        "collection_name_transform": "MyConfiguration48",
        "statusimage": "images/draft.gif",
        "collection_platform_id": "1",
        "statuslabel": "dc.db.config.status.draft",
        "collection_id": "9502000000143001",
        "first_name_transform": "testuser1",
        "cfgdatatocollection_collection_id": "9502000000143001",
        "collection_status": "9",
        "not_applicable_count": null,
        "not_applicable_count_transform": "--",
        "first_name": "testuser1",
        "failed_count_transform": "--",
        "collection_creation_time": "1777280770860",
        "is_single_config": "true",
        "modifieduser_first_name_transform": "testuser1",
        "collection_modified_time_transform": "Apr 27, 2026 02:36 PM",
        "success_count": null,
        "label": "dc.common.SCHEDULER",
        "status_count_desc": null,
        "yet_to_apply_count": null,
        "failed_count": null,
        "customer_id": "9502000000121939",
        "created_from": null
      }
    ],
    "totalPages": 1,
    "Links": {
      "last": "/dcapi/configuration/viewData/configurationsView?_PN=1",
      "first": "/dcapi/configuration/viewData/configurationsView?_PN=1"
    },
    "status": "success"
  }
▼ Show full

Filtered by category=121 (Custom Script) and platFormID=1 (Windows), sorted by name ascending

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 1,
    "messageResponse": [
      {
        "total_target_count": 1,
        "collection_creation_time_transform": "Apr 15, 2026 05:25 PM",
        "modifieduser_user_id": "9502000000121919",
        "status_count_desc_transform": "Success: 1",
        "collection_collection_id": "9502000000143501",
        "dcuserscollectionmapping_collection_id": "9502000000143501",
        "total_target_count_transform": "1",
        "os_platform_name": "Windows",
        "retry_inprogress_count_transform": "0",
        "status_id": "1",
        "collection_modified_time": "1776200770860",
        "config_data_id": "9502000000143503",
        "config_type_transform": "2",
        "config_type": "2",
        "statuslabel_transform": "Deployed",
        "os_platform_id": "1",
        "os_platform_name_transform": "Windows",
        "is_collection_deleted": "false",
        "modifieduser_first_name": "admin",
        "deletedby": null,
        "collection_collection_id_transform": "9502000000143501",
        "success_count_transform": "1",
        "label_transform": "Custom Script",
        "retry_inprogress_count": 0,
        "config_id": "121",
        "user_id": "9502000000121919",
        "small_image_name": "images/customscript.gif",
        "yet_to_apply_count_transform": "0",
        "deleted_time": null,
        "collection_name": "MyConfiguration12",
        "dc_user_id": null,
        "show_in_view": "true",
        "collection_name_transform": "MyConfiguration12",
        "statusimage": "images/deployed.gif",
        "collection_platform_id": "1",
        "statuslabel": "dc.db.config.status.deployed",
        "collection_id": "9502000000143501",
        "first_name_transform": "admin",
        "cfgdatatocollection_collection_id": "9502000000143501",
        "collection_status": "1",
        "not_applicable_count": 0,
        "not_applicable_count_transform": "0",
        "first_name": "admin",
        "failed_count_transform": "0",
        "collection_creation_time": "1776200770860",
        "is_single_config": "true",
        "modifieduser_first_name_transform": "admin",
        "collection_modified_time_transform": "Apr 15, 2026 05:25 PM",
        "success_count": 1,
        "label": "dc.common.CUSTOM_SCRIPT",
        "status_count_desc": "Success: 1",
        "yet_to_apply_count": 0,
        "failed_count": 0,
        "customer_id": "9502000000121939",
        "created_from": null
      }
    ],
    "totalPages": 1,
    "Links": {
      "last": "/dcapi/configuration/viewData/configurationsView?_PN=1&category=121&platFormID=1",
      "first": "/dcapi/configuration/viewData/configurationsView?_PN=1&category=121&platFormID=1"
    },
    "status": "success"
  }
▼ Show full

No configurations match the applied filters

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": 0,
    "messageResponse": [],
    "totalPages": 0,
    "Links": {
      "last": "/dcapi/configuration/viewData/configurationsView?_PN=1",
      "first": "/dcapi/configuration/viewData/configurationsView?_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 configurations 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 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.

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.