Get Pages
Table of Contents
Overview
This API fetches the meta information of all the pages present in a Zoho Creator application.
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 Pages API below:
Request Details
Request URL
https://<base_url>/creator/v2.1/meta/<account_owner_name>/<app_link_name>/pages
Request method
GET
Header
Key | Value | Description |
Authorization | Zoho-oauthtoken100 0.8cb99dxxxxxxxxxxxxx9b e93.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 application from which you want to fetch the form meta information |
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/pages"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
url :"https://www.zohoapis.com/creator/v2.1/meta/jason18/zylker-store/pages"
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 PagesApi
{
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/pages").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/pages", {
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/pages", headers=api_headers)
except:
print("Exception while making the API request.")
Show full
Show less
This sample request will fetch the meta information of all the pages present in the Zylker Store application.
Sample Request for Development/ Stage environments (for C6 users)
Copiedcurl "https://www.zohoapis.com/creator/v2.1/meta/jason18/zylker-store/pages"
-X GET
-H 'Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf'
-H 'environment: development'
Sample Response
Copied{
"code": 3000,
"pages": [
{
"display_name": "Assets Dashboard",
"link_name": "Asset_Dashboard"
},
{
"display_name": "Home",
"link_name": "Home_Page"
}
]
}