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>/creator/v2.1/meta/<account_owner_name>/<app_link_name>/sections
Request method
GET
Header
Key | Value | Description |
Authorization | Zoho-oauthtoken1000.8c b99dxxxxxxxxxxxxx9be 93.9b8xxxxxxxxxxxxxxxf | An authentication token (authtoken) allows users to access apps and APIs without having to enter their login credentials each time. |
environment | development/stage | Refers to the environment stage. |
OAuth scope
scope=ZohoCreator.meta.application.READ
where,
base_url | the base URL of your Creator account For example, it's www.zohoapis.com if your account belongs to Zoho's US DC, and is www.zohoapis.eu if it belongs to Zoho's EU DC. |
account_owner_name | the username of the Creator account's owner |
app_link_name | the link name of the target application |
Possible Errors
Refer to this page for the list of error codes and messages.
Sample Request for Production environment (for C6 users)
Copiedcurl "https://www.zohoapis.com/creator/v2.1/meta/jason18/zylker-store/sections"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
url :"https://www.zohoapis.com/creator/v2.1/meta/jason18/zylker-store/sections"
type :GET
connection:"zoho-creator"
];
info response;
Copiedpackage main.java.org.example;
import okhttp3.HttpUrl;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import org.json.JSONException;
import org.json.JSONObject;
public class SectionsApi
{
public static void main(String[] args) throws JSONException
{
OkHttpClient client = new OkHttpClient();
HttpUrl.Builder urlBuilder = HttpUrl.parse("https://www.zohoapis.com/creator/v2.1/meta/jason18/zylker-store/sections").newBuilder();
Request request = new Request.Builder()
.url(urlBuilder.toString())
.method("GET", null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf")
.build();
try
{
JSONObject response = new JSONObject(client.newCall(request).execute().body().string());
}
catch (Exception e)
{
System.out.println("Exception while making the API request.");
}
}
}
Copiedlet api_headers = {
"Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
try {
let response = fetch("https://www.zohoapis.com/creator/v2.1/meta/jason18/zylker-store/sections", {
method: "GET",
headers: api_headers
})
}
catch (exception) {
console.error(exception)
}
Copiedimport requests
api_headers = {
"Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
try:
response = requests.get("https://www.zohoapis.com/creator/v2.1/meta/jason18/zylker-store/sections", headers=api_headers)
except:
print("Exception while making the API request.")
Show full
Show less
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://www.zohoapis.com/creator/v2.1/meta/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"
}
]
}
Show full
Show less