Get Forms

Overview
OpenAPI Specification
Request Details
Form Types
Possible Errors

Overview

This API fetches the meta information of all the forms 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 Forms API below:

Request Details

Request URL

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

Request method

GET

Header

Key	Value	Description
Authorization	Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.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.

Note: By default, production value will be considered for the environment header.

OAuth scope

scope=ZohoCreator.meta.application.READ

where,

base_url	Zoho 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_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

Form Types

A normal/DB form will have 1 as its type value
A stateless form will have 2 as its type value

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

This sample request will fetch the meta information of all the forms 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/forms"
-X GET 
-H 'Authorization: Zoho-oauthtoken  1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf'  
-H 'environment: development'

Sample Response

Copied{
  "code": 3000,
  "forms": [
    {
      "display_name": "Add Order",
      "link_name": "Order_Form",
      "type": 1
    },
    {
      "display_name": "Add Inventory",
      "link_name": "Inventory_Form",
      "type": 1
    },
    {
      "display_name": "Order Stateless Form",
      "link_name": "Order_Stateless_Form",
      "type": 2
    }
  ]
}