Retrieves a list of all custom reports accessible to the user, along with metadata such as report name, owner, last modified time, and associated view name.
get /dcapi/reports/customReports
https://{serverurl}/dcapi/reports/customReports
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
curl --request GET \
--url https://appdomains/dcapi/reports/customReports \
--header 'Accept: application/allCustomReports.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Root node identifier. Always 'customReports'
Parent node identifier. Always null for the root node
Localized display name of the root node (e.g., Custom Reports)
Root node metadata including report type, expandable, and selectable flags
Report type identifier. Always '2' for Custom Reports
True if child reports exist, false otherwise
False if any child report is affected, disabled, or is a chart; true otherwise
Array of child custom report nodes. Null when no reports exist
Unique report ID (CRSAVEVIEW_ID)
Parent node identifier. Always 'customReports'
Display name of the custom report
Report metadata including owner, view name, action URL, description, and timestamps
First name of the user who created the report
Internal view name stored in the database (e.g., CRVIEW_1776239184200)
Always false for report nodes
True if the report is active, not a chart, and within column/criteria limits; false otherwise
URL path to view the report in the web console
User-provided description of the custom report
Last modified timestamp formatted per the user's time-format preference
Always null for leaf report nodes
Always true for report nodes
Always null for child report nodes
Always false for child nodes
False when children exist, true when no children
Warning message when some reports are affected or disabled. Null when all reports are healthy
Always true for the root node
Unauthorized error code: credentials missing, expired, or invalid
Authentication failure reason
Error code indicating insufficient permissions
Message indicating insufficient privileges to access this resource
Error code: REPORT_UNAUTHORIZED. PMP users are not allowed to access custom reports
Message indicating PMP product users are not authorized to access custom reports
Rate limit error code returned when the API call reached threshold
Rate limit exceeded message with retry guidance
Error code: INTERNAL_ERROR. Unexpected failure during custom report list retrieval (e.g., database exception)
Detailed error description for the internal server error
Root node with two custom report children
{
"parent": null,
"children": [
{
"parent": "customReports",
"children": null,
"root": false,
"errorMessage": null,
"id": "2",
"label": "Untitled2",
"leaf": true,
"properties": {
"owner": "admin",
"viewName": "CRVIEW_1776239184200",
"expandable": false,
"selectable": true,
"actionURL": "/webclient#/uems/reports/report/custom/view-report/2?viewName=CRVIEW_1776239184200",
"description": "Test Description",
"lastModified": "Apr 15, 2026 01:16 PM"
}
},
{
"parent": "customReports",
"children": null,
"root": false,
"errorMessage": null,
"id": "1",
"label": "Untitled1",
"leaf": true,
"properties": {
"owner": "admin",
"viewName": "CRVIEW_1776239157642",
"expandable": false,
"selectable": false,
"actionURL": "/webclient#/uems/reports/report/custom/view-report/1?viewName=CRVIEW_1776239157642",
"description": "Test Description",
"lastModified": "Apr 15, 2026 01:15 PM"
}
}
],
"root": true,
"errorMessage": null,
"id": "customReports",
"label": "Custom Reports",
"leaf": false,
"properties": {
"reportType": "2",
"expandable": true,
"selectable": false
}
}
No saved custom reports — root node with null children
{
"parent": null,
"children": null,
"root": true,
"errorMessage": null,
"id": "customReports",
"label": "Custom Reports",
"leaf": true,
"properties": {
"reportType": "2",
"expandable": false,
"selectable": false
}
}
Missing or invalid authentication token
{
"errorMessage": "Authentication token is missing or invalid",
"errorCode": "401"
}
User does not have the required role
{
"errorMessage": "User does not have the required role to access this resource",
"errorCode": "403"
}
PMP product users are not allowed access
{
"errorMessage": "You are not authorized to access custom reports",
"errorCode": "REPORT_UNAUTHORIZED"
}
Rate limit exceeded
{
"errorMessage": "Rate limit exceeded. Please retry after some time",
"errorCode": "429"
}
Unexpected failure during custom report list retrieval
{
"errorMessage": "Internal server error while fetching custom reports",
"errorCode": "INTERNAL_ERROR"
}
![]()
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.