Get Reports

Overview

This API fetches the meta information of all the reports present in a Zoho Creator application. Refer to this section for the reports supported in Zoho Creator and their type value.

OpenAPI Specification

The OpenAPI Specification(OAS) is the most widely used standard for API description and refers to a standard interface for describing REST APIs. Download the OAS for the Get Reports API below:

Request Details

Request URL

https://<base_url>/api/v2/<account_owner_name>/<app_link_name>/reports

Request method

GET

Header

KeyValueDescription
AuthorizationZoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxfAn authentication token (authtoken) allows users to access apps and APIs without having to enter their login credentials each time.
environmentdevelopment/stageRefers to the environment stage.
Note: By default, production value will be considered for the environment header.

OAuth scope

scope=ZohoCreator.meta.application.READ

where,

base_urlZoho Creator:
The base URL of your Creator account
For example, it's creator.zoho.com if your account belongs to Zoho's US DC, and is creator.zoho.eu if it belongs to Zoho's EU DC.

Zoho Creator On-premise:
The base URL specific to your Zoho Creator On-premise account. This URL will be either https://host_name:port_number (learn more) or the hostname of the server where Creator On-prem is running.
account_owner_namethe username of the Creator account's owner
app_link_namethe link name of the application from which you want to fetch the form meta information

Report types

Type of ReportIts "type" value
List1
Calendar2
List report that's set with a non-tabular (card-like) quick view layout3
Kanban4
Map5
Spreadsheet6
Pivot Table7
Pivot Chart8
List report that's set with a custom quick view layout9
Timeline10

Possible Errors

Refer to this page for the list of error codes and messages.

Sample Request for Production environment (for C6 users)

Copiedcurl "https://creator.zoho.com/api/v2/jason18/zylker-store/reports"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

This sample request will fetch the meta information of all the reports present in the Zylker Store application.

Sample Request for Development/ Stage environments (for C6 users)

Copiedcurl "https://creator.zoho.com/api/v2/jason18/zylker-store/reports"
-X GET 
-H 'Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf'  
-H 'environment: development'

Sample Response

Copied{
  "code": 3000,
  "reports": [
    {
      "display_name": "List Report",
      "link_name": "List_Report",
      "type": 1
    },
    {
      "display_name": "Calendar Report",
      "link_name": "Calendar_Report",
      "type": 2
    },
    {
      "display_name": "Kanban Report",
      "link_name": "Kanban_Report",
      "type": 4
    },
    {
      "display_name": "Map Report",
      "link_name": "Map_Report",
      "type": 5
    },
    {
      "display_name": "Spreadsheet Report",
      "link_name": "Spreadsheet_Report",
      "type": 6
    },
    {
      "display_name": "Pivot Table",
      "link_name": "Pivot_Table",
      "type": 7
    },
    {
      "display_name": "Pivot Chart",
      "link_name": "Pivot_Chart",
      "type": 8
    },
    {
      "display_name": "List Report with Custom QuickView Layout",
      "link_name": "List_Report_Custom_Layout",
      "type": 9
    },
    {
      "display_name": "Timeline Report",
      "link_name": "Timeline_Report",
      "type": 10
    }
  ]
}