Get Sections

Overview

This API fetches the information about the sections and underlying components—forms, reports, and pages—defined for a Zoho Creator application's web form factor. Refer to this section to learn about the component 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 Sections API below:

Request Details

Request URL

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

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 target application

Component Types

The type value in the response identifies the component type.

ComponentIts "type" value
Form1
Report2
Page3

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/sections"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

This sample request will fetch the information about the sections, and underlying compnents, defined for the Zylker Store application's web form factor

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

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

Sample Response

Copied{
  "code": 3000,
  "sections": [
    {
      "components": [
        {
          "page_type": 2,
          "type": 3,
          "link_name": "Dashboard",
          "display_name": "Dashboard"
        }
      ],
      "display_name": "Dashboard",
      "link_name": "Dashboard"
    },
    {
      "components": [
        {
          "view_type": 1,
          "type": 2,
          "link_name": "All_Order_Line_Items",
          "display_name": "All Order Line Items"
        },
        {
          "view_type": 1,
          "type": 2,
          "link_name": "All_Orders",
          "display_name": "All Orders"
        }
      ],
      "display_name": "Orders",
      "link_name": "Orders1"
    },
    {
      "components": [
        {
          "view_type": 1,
          "type": 2,
          "link_name": "All_Products",
          "display_name": "All Products"
        }
      ],
      "display_name": "Inventory",
      "link_name": "Inventory"
    },
    {
      "components": [
        {
          "view_type": 1,
          "type": 2,
          "link_name": "All_Customers",
          "display_name": "All Customers"
        },
        {
          "view_type": 1,
          "type": 2,
          "link_name": "Sales_Reps_Report",
          "display_name": "Sales Reps Report"
        },
        {
          "view_type": 1,
          "type": 2,
          "link_name": "Logistics_Partners_Report",
          "display_name": "Logistics Partners Report"
        }
      ],
      "display_name": "Other Reports",
      "link_name": "Other_Reports"
    }
  ]
}