JS API documentation

This help page is for users in Creator 6. If you are in the older version (Creator 5), click here . Know your Creator version .

Download the latest JS SDK library from the CDN URL given below and link it using the script tag.

CDN URL - https://js.zohostatic.com/creator/widgets/version/1.0/widgetsdk-min.js

Initialize the SDK using the below method and use then block to write the logic

ZOHO.CREATOR.init()
.then(function(data) {
//Code goes here
});

To get the value from the parameters configured in pages, use the below method

var queryParams = ZOHO.CREATOR.UTIL.getQueryParams();

To get the login user's email address, use the below method

var initparams = ZOHO.CREATOR.UTIL.getInitParams();

Sample response:

{
"scope": "zylkercorp",
"envUrlFragment": "/environment/development",
"appLinkName": "widgetapp",
"loginUser": " john@zylker.com "
}

The values of the image field will be an API endpoint in case the image is uploaded from computer or phone, use the below method to convert the endpoint to image data and assign the value to the source of the image tag. In another case, the image can be a public image link, and this method works for both cases.

var imageTag = document.getElementById("imgtag");
var imageURL = "/api/v2/zylker/Contacts/view/All_Contacts/66359000000015039/Upload/download";
ZOHO.CREATOR.UTIL.setImageData(imageTag, imageURL, callbackFunction);

Widget API allows customers to push and pull data from other apps in their Creator account. The success of the API call to push or pull data in other apps depends on the permissions provided for users of that app.

Record APIs

These APIs help you perform different tasks with the records of the application. The various Record APIs are as follows:

Note : appName needs to be passed only when you need to push or pull data from other apps in your account.

Add Record
Update Record
Get All Records
Get Specific Record Using ID
Get Record Count
Delete Record
Upload File

Add Record

Method : addRecord

Name	Description
formName	Link name of the form to which the records to be added. Refer this page to view and change the link name.
data	Form data in json format, where the format for all the fields has been specified here.
appName	Link name of the application from which data needs to be pushed to.

Syntax :

//configuration json
config = {
appName : "${APPNAME}",
formName : "${FORMNAME}",
data : "${FORMDATA}"
}
//add record API
ZOHO.CREATOR.API.addRecord(config).then(function(response){
//callback block
});


                  
                     
                        Example : 
                     
                     

                  
                  
                     
                        
                           
                           
                        
                        

                     
                     
                        
                           //configuration json
                           

                        
                        
                           var config = { 
                           

                        
                        
                                        appName : "zylker",
                        
                        
                                        formName : "timesheet",
                        
                        
                                        data : formData
                        
                        
                           } 
                           

                        
                        
                           //add record API 
                           

                        
                        
                           
                              
                                 ZOHO.CREATOR.API.addRecord(config).then(function(response){ 
                              
                           
                           

                        
                        
                           
                              
                                        if(response.code == 3000){ 
                              
                           
                           

                        
                        
                           
                              
                                        console.log("Record added successfully"); 
                              
                           
                           

                        
                        
                           } 
                           

                        
                        
                           }); 
                           

                        
                     
                  
                  
                     
                        Form data :
                     
                     
                        
                        
                     
                     

                  
                  
                     
                        
                           
                              formData = {
                           
                           
                                  "data" : {
                           
                           
                                      "Name": {
                           
                           
                                          "first_name": "James",
                           
                           
                                          "last_name": "Kyle",
                           
                           
                                      },
                           
                           
                                      "Address": {
                           
                           
                                          "address_line_1": "Dari Mart",
                           
                           
                                          "address_line_2": "Hayden Bridge Rd",
                           
                           
                                          "district_city" : "Springfield",
                           
                           
                                          "state_province" : "Oregon",
                           
                           
                                          "postal_code" : "97477",
                           
                           
                                          "country" : "United States"
                           
                           
                                      },
                           
                           
                                      "Rich_Text" : "The phone number is <b>+1541-726-4051</b>",
                           
                           
                                      "Phone_Number": "+15417264051",
                           
                           
                                      "Single_Line": "A simple one line text",
                           
                           
                                      "Email": "
                              
                                 james@zylker.com
                              
                              ",
                           
                           
                                      "Dropdown" : "Open",
                           
                           
                                      "Radio" : "Closed",
                           
                           
                                      "Multi_Select" : ["New", "Used"],
                           
                           
                                      "Checkbox" : ["Refurbished", "Used"],
                           
                           
                                      "Number": "1000",
                           
                           
                                      "Decimal" : "1000.00",
                           
                           
                                      "Percent": "60.00",
                           
                           
                                      "Date_field" : "10-Jan-2020",
                           
                           
                                      "Date_Time" : "23-Mar-2020 12:25:43 PM",
                           
                           
                                      "Image" : "
                              
                                 https://www.zylker.com/sites/default/profile-01.jpg",
                              
                           
                           
                                      "Ur1": {
                           
                           
                                          "value": "Dari Mart",
                           
                           
                                          "url": "
                              
                                 www.darimart.com",
                              
                           
                           
                                          "title": "Dari mart provisional store"
                           
                           
                                      },
                           
                           
                                      "Lookup_Single_Select" : "521270000078464",
                           
                           
                                      "Lookup_Multi_Select" : ["5212750000247932","5212750000564867"],
                           
                           
                                      "SubForm" : [
                           
                           
                                          {
                           
                           
                                              "Single_Line" : "Service Equipment",
                           
                           
                                              "Dropdown" : "New Order"
                           
                           
                                          },
                           
                           
                                          {
                           
                           
                                              "Single_Line" : "Rotary Machine",
                           
                           
                                              "Dropdown" : "Replacement",
                           
                           
                                          }
                           
                           
                                      ]
                           
                           
                                  }
                           
                           
                              }
                           
                        
                     
                  
                  
                     
                        Response :

response = {
"code": 3000,
"data": {
"ID": "2000000245119"
},
"message": "success"
}

Update Record

Method : updateRecord

Name	Description
reportName	Link name of the report through which the record to be updated. Refer here to get and update the link name of a report
id	ID value of the record to be updated
data	Form data in json format, where format for all the fields have been specified here
appName	Link name of the application in which data needs to be updated.

Syntax :

//configuration json
config = {
appName : "${APPNAME}",
reportName : "${REPORTNAME}",
id: "${RECORDID}",
data : "${FORMDATA}"
}
//update record API
ZOHO.CREATOR.API.updateRecord(config).then(function(response){
//callback block
});

Example :

var config = {
appName : "zylker"
reportname : "All-Timesheet",
id : "2000000245119"
data : formData
}
ZOHO.CREATOR.API.updateRecord(config).then(function(response){
if(response.code == 3000){
console.log("Record updated successfully");
}
});

Response :

response = {
"code": 3000,
"data": {
"ID": "2000000245119"
},
"message": "success"
}

Get All Records

Method : getAllRecords

Configuration :

Name	Description
reportName	Link name of the report through which the record to be updated. Refer here to get and update the link name of a report
criteria (optional)	Condition to filter the record, which is applied along with the condition specified in the report filter. The criteria must be specified in the following format is the link name of the field, which compares with the and the comparison is based on the . The supported operators are !=, <=, >=,<, >, == You can combine more than one criteria using logical AND (&&) and logical OR(\|\|) Example : (Stage == "Open" && Score > 40)
page (optional)	Index or number of the page to be retrieved. The default page number is 1
pageSize (optional)	Total number of records to be retrieved in the specified page. The default size is 100 and the maximum size is 200
appName	Link name of the application from which data needs to be pulled from.

Note :

The response will return the data that’s displayed in both the Quick view and Detail view of the corresponding report
When the Detail view sports a related block of data, which is related via a lookup field, this API’s response will also include the data from that lookup field's display fields.

Syntax :

//configuration json
config = {
appName : "${APPNAME}",
reportName : "${REPORTNAME}",
criteria: "${CRITERIA}",
page : "${PAGENUMBER}",
pageSize : "${PAGESIZE}"
}
//get all records API
ZOHO.CREATOR.API.getAllRecords(config).then(function(response){
//callback block
});

Example :

var config = {
appName : "zylker"
reportName : "All-Timesheet",
criteria : "(Status == \"Open\" && Priority = \"High\")",
page : 1,
pageSize : 10
}
ZOHO.CREATOR.API.getAllRecords(config).then(function(response){
var recordArr = response.data;
for(var index in recordArr){
console.log(recordArr[index]);
}
});

Response :

response = {
"code": 3000,
"data": [
{
"ID": "52129000000146011",
"Name": {
"first_name": "James",
"last_name": "Kyle",
"display_value": "James Kyle"
},
"Address": {
"address_line_1": "Dari Mart",
"address_line_2": "995 Hayden Bridge Rd",
"district_city": "Springfield",
"state_province": "Oregon",
"postal_code": "97477",
"country": "United States",
"latitude": "33.9307727",
"longitude": "-116.8767541",
"display_value": "Dari Mart, 995 Hayden Bridge Rd, Springfield, Oregon, United States"
},
"Rich_Text": "The phone number is <b>+1541-726-4051</b>",
"Phone_Number": "+15417264051",
"Single_Line": "A simple one line text",
"Email": " james@zylker.com ",
"Number": "23",
"Decimal": "1000.00",
"Percent": "60.00",
"Date_field": "10-Jan-2020",
"Date_Time": "23-Mar-2020 12:25:43 PM",
"Dropdown": "Open",
"Radio": "Closed",
"Multi_Select": [
"New",
"Used"
],
"Checkbox": [
"Refurbished",
"Used"
],
"Image": " https://www.zylker.com/sites/default/profile-01.jpg",
"File_Upload": "/api/v2/zylker/Contacts/view/Contacts/635900380/Upload/download",
"Ur1": {
"value": "Dari Mart",
"url": " www.darimart.com",
"title": "Dari mart provisional store"
},
"Lookup_Single_Select": {
"display_value": "James - 4269",
"ID": "521270000078464"
},
"Lookup_Multi_Select": [
{
"display_value": "Door Step Delivery",
"ID": "5212750000247932"
},
{
"display_value": "Cash on Delivery",
"ID": "5212750000564867"
}
],
"Subform": [
{
"display_value": "Service Equipment,New Order",
"ID": "5212750000433263"
},
{
"display_value": "Rotary Machine,Replacement",
"ID": "5212750000090778"
}
]
},
{
//Record 2
},
{
//Record 3
}
]
}

Get Specific Record Using ID

Method : getRecordById

Configuration :

Name	Description
reportName	Link name of the report through which the record to be updated. Refer here to get and update the link name of a report
id	ID value of the record to be retrieved
appName	Link name of the application from which data needs to be pulled from.

Note:

The response will return the data that’s displayed in both the Quick view and Detail view of the corresponding report
When the Detail view sports a related block of data, which is related via a lookup field, this API’s response will also include the data from that lookup field's display fields.

Syntax :

//configuration json
config = {
appName : "${APPNAME}",
reportName : "${REPORTNAME}",
id: "${RECORDID}"
}
//get specific record API
ZOHO.CREATOR.API.getRecordById(config).then(function(response){
//callback block
});

Example :

var config = {
appName : "zylker"
reportName : "All-Timesheet",
id : "2000000193171"
}
ZOHO.CREATOR.API.getRecordById(config).then(function(response){
console.log(response.data);
});

Response :

response = {
"code": 3000,
"data": {
"ID": "52129000000146011",
"Name": {
"first_name": "James",
"last_name": "Kyle",
"display_value": "James Kyle"
},
"Address": {
"address_line_1": "Dari Mart",
"address_line_2": "995 Hayden Bridge Rd",
"district_city" : "Springfield",
"state_province" : "Oregon",
"postal_code" : "97477",
"country" : "United States"
"latitude": "33.9307727",
"longitude": "-116.8767541",
"display_value": "Dari Mart, 995 Hayden Bridge Rd, Springfield, Oregon, United States"
},
"Rich_Text" : "The phone number is <b>+1541-726-4051</b>",
"Phone_Number": "+15417264051",
"Single_Line": "A simple one line text",
"Email": " james@zylker.com ",
"Number": "23",
"Decimal" : "1000.00",
"Percent": "60.00",
"Date_field" : "10-Jan-2020",
"Date_Time" : "23-Mar-2020 12:25:43 PM",
"Dropdown" : "Open",
"Radio" : "Closed",
"Multi_Select" : ["New", "Used"],
"Checkbox" : ["Refurbished", "Used"],
"Image" : " https://www.zylker.com/sites/default/profile-01.jpg",
"File_Upload" : "/api/v2/zylker/Contacts/view/Contacts/635900380/Upload/download",
"Ur1": {
"value": "Dari Mart",
"url": " www.darimart.com",
"title": "Dari mart provisional store"
},
"Lookup_Single_Select" : {
"display_value" : "James - 4269",
"ID" : "521270000078464"
},
"Lookup_Multi_Select" : [{
"display_value" : "Door Step Delivery",
"ID" : "5212750000247932"
},
{
"display_value" : "Cash on Delivery",
"ID" : "5212750000564867"
}],
"Subform" : [{
"display_value" : "Service Equipment,New Order",
"ID" : "5212750000433263"
},
{
"display_value" : "Rotary Machine,Replacement",
"ID" : "5212750000090778"
}]
}
}

Get Record Count

Method : getRecordCount

Configuration :

Name	Description
reportName	Link name of the report for which the record count is required. Refer here to get and update the link name of a report
appName	Link name of the application from which data needs to be pulled from and counted.
criteria (optional)	Condition to filter the record, which is applied along with the condition specified in the report filter. The criteria must be specified in the following format is the link name of the field, which compares with the and the comparison is based on the . The supported operators are !=, <=, >=,<, >, == You can combine more than one criteria using logical AND (&&) and logical OR(\|\|) Example : (Stage == \"Open\" && Score > 40)

Syntax :

//configuration json
config = {
appName: "first-application",
reportName: "Form_Report",
criteria: "(Single_Line = \"High\")" //optional
}
ZOHO.CREATOR.API.getRecordCount(config).then(function (response) {
//your code goes here.
});

Example:

var config = {
appName : "zylker"
reportName : "All-Timesheet",
}
ZOHO.CREATOR.API.getRecordCount(config).then(function (response){
console.log(response);
});

Response:

response =
{
"result": {
"records_count": "4"
},
"code": 3000
}

Delete Record

Method : deleteRecord

Configuration :

Name	Description
reportName	Link name of the report through which the record to be updated. Refer here to get and update the link name of a report
criteria	Condition to filter the record, which is applied along with the condition specified in the report filter. The criteria must be specified in the following format <Field Name> <Operator> <Value> <Field name> is the link name of the field, which compares with the<Value> and the comparison is based on the <Operator>. The supported operators are !=, <=, >=,<, >, == You can combine more than one criteria using logical AND (&&) and logical OR(\|\|) Example : (Stage == "Open" && Score > 40)
appName	Link name of the application from which data needs to be deleted.

Note: The maximum of 200 records can be deleted for every API call and you will receive error when the number of records exceeds 200.

Syntax :

//configuration json
config = {
appName : "${APPNAME}",
reportName : "${REPORTNAME}",
criteria: "${CRITERIA}"
}
//delete record API
ZOHO.CREATOR.API.deleteRecord(config).then(function(response){
//callback block
});

Example :

var config = {
appName : "zylker"
reportName : "All-Timesheet",
criteria : "(Status == \"Invalid\" && Date '01-01-2019')"
}
ZOHO.CREATOR.API.deleteRecord(config).then(function(response){
console.log("Record has been deleted");
});

Response :

response = {
"result": [{
"code": 3000,
"data": {
"ID": "66359000000021016"
},
"message": "success"
},
{
"code": 3000,
"data": {
"ID": "66359000000024309"
},
"message": "success"
}
],
"code": 3000
}

Upload File

Method : uploadFile

Configuration :

Name	Description
reportName	Link name of the report through which the record to be updated. Refer here to get and update the link name of a report
id	ID value of the record where the file to be uploaded
fieldName	Link name of the field to which the file has to be uploaded. Refer here to get the link name of the field. The allowed field types are Image, Signature, File Upload, Audio, and Video. In case the file has to be uploaded to a field which has been added inside a subform, the fieldName will be subform field link name followed by the field link name of the field to be uploaded with (dot) in between. Example: ${SUBFORMFIELDNAME.FIELDNAME}
fiel	It is a javascript File object to be uploaded. Refer here to know more about javascript File API
parentId	In case the file has to be uploaded to a field which has been added inside a subform, then the parentId is the ID value of the parent record, i.e the main form record in which the subform has been embedded.
appName	Link name of the application in which data needs to be uploaded.

Note: The file can be uploaded only after submitting a record and this API will upload one file to one field at a time. In case of more number of fields in a form, this API need to call for each field separately.

Syntax :

//configuration json
config = {
appName : "${APPNAME}",
reportName : "${REPORTNAME}",
id: "${RECORDID}",
fieldName : "${SUBFORMFIELDNAME.FIELDNAME}",
parentId : "${RECORDID}",
file : "${FILEOBJECT}"
}
//upload file API
ZOHO.CREATOR.API.uploadFile(config).then(function(response){
//callback block
});

Example:

var fileObject = document.getElementById("fileInput").files[0];
var config = {
appName : "zylker"
reportName : "All-Timesheet",
id : "2000000193171",
fieldName : "Attachments",
file : fileObject
}
ZOHO.CREATOR.API.uploadFile(config).then(function(response){
console.log("File uploaded successfully");
});

Response :

response = {
"code": "3000",
"data": {
"filename": "Rental Agreement-March.pdf",
"filepath": "1587402896598_Rental_Agreement-March.pdf",
"message": "success"
}
}

Access your files securely from anywhere

Zoho CRM Training Programs

Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

Redefine the way you work

with Zoho Workplace

Start your free trial

Zoho DataPrep Personalized Demo

If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

Create, share, and deliver

beautiful slides from anywhere.

Get Started Now

Zoho Sign now offers specialized one-on-one training for both administrators and developers.

BOOK A SESSION

Zoho Workerly Home
Forums
Connect With Us:

Zoho Recruit Home
Forums
Connect With Us:

Start tracking your website metrics today

Use PageSense to understand what your visitors are looking for, how they are behaving, and where they are facing problems on your website.

Ready to improve your website's performance?

Install the PageSense code snippet on your site in a matter of minutes and start collecting in-depth data about the website visitors to grow your business.

Track and measure every business goal

Set up goals in PageSense to measure every single action performed by visitors on your website like button or link clicks, form submissions, and page engagements.

Understand the customer journey on your website

Create funnels in PageSense to quickly see which pages visitors use to enter your website, where they navigate to next, and which pages they decide to leave without converting.

Visualize your visitor's behavior with color codes

Set up heatmaps in PageSense to see where users have clicked more, how far they've scrolled, and on which parts of a page they've spent the most time using color-coded patterns in reports.

Measure customer engagement with your web forms

Use form analytics in PageSense to see how people interact with different fields in your form, whether they complete the form successfully or not, and where exactly they drop out on your form.

Record real visitor interactions on your website

Use session recordings in PageSense to watch a video of all the visitor actions performed on your website including the pages they navigate, the buttons they click, the UX issues they face, and more.

Test and optimize webpages for better conversions

Run A/B or Split URL tests in PageSense to figure out which version of your web page works best for your business and results in the best conversion rate.

Give each customer a unique website experience

Use personalization in PageSense to deliver customized versions of your website for every individual customer based on their demographics, local weather, browsing history, and more.

Grow your business through customer feedback

Run polls on your website using PageSense to understand what your customers think about your products/services and what needs improvement on your site.

Send timely updates that customers love

Use web push notifications in PageSense to schedule and notify your customers about an upcoming flash sale, product releases, promotional coupons, and a lot more that can spark conversions on your website.

Advertise your business to website visitors

Use pop-ups in PageSense to instantly grab the attention of visitors by showing attractive signup offers, coupon code discounts, or email newsletters that can eventually convert them into subscribers.

Access more advanced settings in PageSense

Use PageSense's advanced features like creating mutually exclusive groups, enabling cross-domain tracking, configuring customized project JS, and more to get deeper insights about your website.

Try easy-to-use extensions

Download the PageSense extension app available for your web browser with a few clicks and start collecting all of your required website metrics in real time.

Discover your favorite integrations with PageSense

Get a deeper look at your website's data by seamlessly integrating PageSense with a host of popular third-party apps like Google Analytics, Mixpanel, Intercom, and more.

Quick Links	Workflow Automation	Data Collection
Web Forms	Enterprise	Begin Data Collection
Interactive Forms	Workplace	Data Collection App
Offline Forms	Customer Service	Accessible Forms
Digital Forms	Marketing	Forms for Small Business
HTML Forms	Education	Forms for Enterprise
Contact Forms	E-commerce	Forms for any business
Lead Generation Forms	Healthcare	Forms for Startups
Wordpress Forms	Customer onboarding	Order Forms for Small Business
No Code Forms	Construction
Free Forms	Travel
Prefill Forms	Non-Profit
Intake Forms	Legal
Form Designer	HR
Card Forms	Food
Assign Forms	Photography
Translate Forms	Real Estate
Electronic Forms
Notification Emails for Forms
Holiday Forms
Form to PDF
Email Forms CRM Forms Embeddable Forms Drag and Drop form builder HIPAA Forms Encrypted Forms

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

Zoho Pagesense Resources

You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.

New to Zoho Survey?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho Social?

Manage your brands on social media

Access Zoho Social

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Zoho Sheet Resources

New to Zoho Forms?

Latest Feature Updates

Explore our Pricing & Plans

Zoho Forms Resources

Secure your business

communication with Zoho Mail

Get started

Mail on the move with

Zoho Mail mobile application

Go Mobile

Stay on top of your schedule

at all times

Get started

Carry your calendar with you

Anytime, anywhere

Get started

Latest Announcements

New to Zoho Sign?

Zoho Sign Resources

Sign, Paperless!

Sign and send business documents on the go!

Get Started Now

Zoho SalesIQ Resources

New to Zoho TeamInbox?

Zoho TeamInbox Resources

Connect with us

New to Zoho ZeptoMail?

LEARN MORE

Latest Feature Updates

Zoho DataPrep Resources

New to Zoho DataPrep?

Access Zoho DataPrep

Zoho DataPrep Demo

Get a personalized demo or POC

Design. Discuss. Deliver.

Create visually engaging stories with Zoho Show.

Get Started Now

New to Zoho Workerly?

Access Zoho Workerly

New to Zoho Recruit?

Access Zoho Recruit

New to Zoho CRM?

Signup Now

Access Zoho CRM

Latest Feature Updates

New to Zoho Projects?

Access Zoho Projects

New to Zoho Sprints?

Access Zoho Sprints

New to Zoho Assist?

Access Zoho Assist

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Related Articles
Generate Barcode using third-party API
Requirement Generate a barcode based on the provided IMEI (International Mobile Equipment Identity) number using a third-party API. Use Case A mobile store uses an order management application to manage their orders. The application has a form ...
Create and manage node.js functions
A function is a set of statements that is invoked in an application to perform a certain action or yield a desired result based on the logic in the code. Node.js is a cross-platform, open-source JavaScript runtime environment. Introducing Node.js ...
API Access Control
Zoho Creator's Rest API allows you to interface with your Zoho Creator applications to fetch, add, update, and delete data. The API access control page lets you restrict the applications that can be accessed using these APIs. To Enable or Disable API ...
Use widgets to create an online mobile store
Requirement Display a card layout with each card containing mobile details like an image, company, model, and features. Any third party languages can also be used, provided the required dependencies like packages, CDN URLs etc. are included. Users ...
Whitelisting of URLs
This help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version. By default, Widgets are allowed access only the Creator servers and subsequently all other URLs are blocked. To use any ...