Skip to product menu
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Payroll software with automated tax payments and filing.

Try now
New

Robotic process automation software to automate high-volume, rule-based tasks.

Try for free
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Privacy-friendly application analytics solution.

Try for free

Sales

 
CRM

Comprehensive CRM platform for customer-facing teams.

CRM
 
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
 
Forms

Build online forms for every business need.

Forms
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Sign

Digital signature app for businesses.

Sign
 
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

 
Social

All-in-one social media management software.

Social
 
Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
 
Forms

Build online forms for every business need.

Forms
 
Survey

Design surveys to reach and interact with your audience.

Survey
 
Sites

Online website builder with extensive customisation options.

Sites
 
PageSense

Website conversion optimization and personalisation platform.

PageSense
 
Backstage

End-to-end event management software.

Backstage
 
Webinar

Webinar platform for webcasting online webinars.

Webinar
 
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
 
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
 
Publish

Manage all your local business listings on a single platform.

Publish
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Sign

Digital signature app for businesses.

Sign
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
 
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
 
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

 
Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

 
Desk

Helpdesk software to deliver great customer support.

Desk
 
Assist

Remote support and unattended remote access software.

Assist
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
FSM

End-to-end field service management platform for service businesses.

FSM
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

 
Books

Powerful accounting platform for growing businesses.

Books
 
FREE
Invoice

100% Free invoicing solution.

Invoice
 
Expense

Effortless expense reporting platform.

Expense
 
Inventory

Powerful stock management and inventory control software.

Inventory
 
Billing

End-to-end billing solution for your business.

Billing
 
Checkout

Collect payments online with custom branded pages.

Checkout
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Practice

Practice management software for accounting firms.

Practice
 
Sign

Digital signature app for businesses.

Sign
 
Commerce

eCommerce platform to manage and market your online store.

Commerce
 
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email and Collaboration

 
Mail

Secure email service for teams of all sizes.

Mail
 
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
 
Writer

Word processor for focused writing and discussions.

Writer
 
Sheet

Spreadsheet software for collaborative teams.

Sheet
 
Show

Create, edit, and share slides with a sleek presentation app.

Show
 
Notebook

Beautiful home for all your notes.

Notebook
 
Cliq

Stay in touch with teams no matter where you are.

Cliq
 
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
TeamInbox

Shared inboxes for teams.

TeamInbox
 
WorkDrive

Online file management for teams.

WorkDrive
 
Sign

Digital signature app for businesses.

Sign
 
Office Suite

Powerful collaborative work platform for teams.

Office Suite
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
 
Learn

Knowledge and learning management platform.

Learn
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
ToDo

Collaborative task management for individuals and teams.

ToDo
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
 
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

 
People

Organize, automate, and simplify your HR processes.

People
 
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
 
Expense

Effortless expense reporting platform.

Expense
 
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Shifts

Employee scheduling and time tracking app.

Shifts
 
Sign

Digital signature app for businesses.

Sign
 
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

 
Creator

Build custom apps to simplify business processes.

Creator
 
Directory

Workforce identity and access management solution for cloud businesses.

Directory
 
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
 
Vault

Online password manager for teams.

Vault
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
Assist

Remote support and unattended remote access software.

Assist
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA

BI and Analytics

 
Analytics

Modern self-service BI and analytics platform.

Analytics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
 
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT

Project Management

 
Projects

Manage, track, and collaborate on projects with teams.

Projects
 
Sprints

Planning and tracking tool for scrum teams.

Sprints
 
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo

Developer Platforms

 
Creator

Build custom apps to simplify business processes.

Creator
 
Flow

Automate business workflows by creating smart integrations.

Flow
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
 
NEW
Apptics

Application analytics for all apps.

Apptics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep

IoT

 
NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

 
CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
 
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
 
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
 
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
 
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
 
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
 
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho One
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Marketplace

Join us for the biggest low-code event of the year. Register now!

x
Skip to main content

Choose where you’d like to start

Get Records

Note: The Creator V1 integration tasks are deprecated and will work until Creator V1 APIs reach their end of life on February 3rd, 2021. Click here for Zoho Creator V2 integration tasks.

Overview

This task is used to fetch records from an application in Zoho Creator.

Syntax

<variable> = zoho.creator.v1.getRecords(<ownerName>, <appLinkName>, <viewLinkName>, <condition>, <fromIndex>, <toIndex>, <connectionlinkName>);

where,

ParameterData TypeDescription

<variable>

LIST

Variable which will hold the returned response.

<ownerName>

TEXT

is the name of the owner of the app from the records will be fetched.

Name of the app owner is present in the url while editing the app: creator.zoho.com/appbuilder/<appOwner>

App owner name can also be fetched using the system variable zoho.adminuser

<appLinkName>

TEXT

is the link name of the application from which the records will be fetched.

Link names of applications, reports, and fields in your account can be viewed here (listed in brackets).

Application Link name can also be fetched using the system variable zoho.appname

<viewLinkName>

TEXT

is the link name of the view (report) from which the records will be fetched.

Link names of applications, reports, and fields in your account can be viewed here (listed in brackets).

<condition>


(optional)

TEXT

is the condition based on which records will be fetched.

The condition must be in the following format:
"<fieldLinkName>==<searchValue>"

Lookup fields must be specified in the format <LookupFieldLinkName>.<displayFieldLinkName>

Note: If your search condition contains hard-coded string value, it needs to be enclosed in double quotes escaped with backslashes. For example, the search condition, "Task_Name==Service Task" should be provided as "Task_Name==\"Service Task\"".

<fromIndex>

<toIndex>


(optional)

NUMBER

<fromIndex> is the starting index of the records (which meet the criteria) that will be retrieved.

<toIndex> is the last index of the records (which meet the criteria) that will be retrieved.

Only first 20 records will be fetched if <fromindex> and <toindex> params are not specified. 

You can specify the <fromindex> without specifying <toindex>, in which case 20 records will be fetched starting from the specified <fromindex>.

The <toIndex> param cannot be specified without the <fromIndex> param.

Using <fromindex> and <toindex> params you can fetch upto 200 records. So, if the difference between the <fromindex> and <toindex> exceeds 200, only the first 200 records will be fetched.

<connectionLinkName>

(optional)*

TEXT

is the name of the Zoho Creator connection.

*Note

  • The connectionLinkName is mandatory when executed in Zoho Cliq.
  • The connection should be authtoken based. To create authtoken based connection with Zoho services, choose the default service - Zoho under pick your service in connections page.

Example 1

Let us consider the below example of searching for a record using a condition in Zoho Creator. The record whose task name is ServiceTask is being fetched here.

Assume that we have a form with the two fields - Task_Name (Single Line Field Type) and Task_Description (Single Line Field Type). The arguments - Task_Management (Application Link Name), Create_Task (View Link Name), john (Owner Name) will be supplied to getRecords task in the following example.

response = zoho.creator.v1.getRecords("john","Task_Management","Create_Task","Task_Name == \"ServiceTask\"");

where,

response
is a KEY-VALUE pair that holds the response of the getRecords task
john
is a TEXT value that represents the application owner's name
Task_Management
is a TEXT value that represents the application's link name
Create_Task
is a TEXT value that represents the view's link name
Task_Name == ServiceTask
is a TEXT value that represents the condition to search records

Example 2

Let us consider the below example of searching for records without a condition or the start and end indices in Zoho Creator.

response = zoho.creator.v1.getRecords("SampleApps","Task_Management","Create_Task");

Example 3

Let us consider the below example of searching for a record using a condition in Zoho Creator.

Assume that we have a form with a lookup field - Department (Lookup Field Type) which refers to the Name (single line field type) field in the related form called "Department". The arguments - Employee_Management (Application Link Name), Employees (View Link Name), tony (Owner Name) will be supplied to getRecords task in the following example.

response = zoho.creator.v1.getRecords("tony","Employee_Management","Employees","Department.Name == \"Electrical\"");

where,

response
is a KEY-VALUE pair that holds the response of the getRecords task
tony
is a TEXT value that represents the application owner's name
Employee_Management
is a TEXT value that represents the application's link name
Employees
is a TEXT value that represents the view's link name
Department.Name == Electrical
is a TEXT value that represents the condition to search records

Sample Response

Success Response for Example 1

Following is a successful response received after fetching a record

{
"Task_Description":"I need help installing my air conditioner",
"ID":3605445000000075003,
"Task_Name":"ServiceTask"
}

Success Response for Example 2

Following is a successful response received on fetching records without a condition/index

{"Task_Name":"Priority Task","Task_Description":"I need help installing my air conditioner","ID":"3605445000000075003"},
{"Task_Name":"Support Ticket1","Task_Description":"Toaster Configurations","ID":"3605445000000065010"},
{"Task_Name":"Support Ticket2","Task_Description":"Help me fix it","ID":"3605445000000065003"},
{"Task_Name":"Support Task1","Task_Description":"I need a call back","ID":"3605445000000063122"},
{"Task_Name":"Support Task1","Task_Description":"My new box broke","ID":"3605445000000063115"},
{"Task_Name":"Task1","Task_Description":"I need a technician visit my place","ID":"3605445000000058048"},
{"Task_Name":"Task2","Task_Description":"The water ain't flowing through the hose","ID":"3605445000000058043"},
{"Task_Name":"Tasks1","Task_Description":"Please get my iron box fixed ASAP","ID":"3605445000000058036"}


To get the IDs of the fetched records, execute the following snippet:

for each <loop_variable> in <response_variable>
{
info var.get("ID"); ​
}

Error

Following is an error when the user tries to search for a record with an incorrect application name:

{
"message":"Please verify whether you gave a valid ownerName,appLinkName and viewLinkName or not",
"status":"Failure"
}

Following is an error when the user tries to search for a record with a non-existent or incorrect record ID:

{
"message":"There is no records match for this condition"
}

Related Links

  • To fetch the string value to which the specified key is mapped, use get()
  • To get values from fetched records, use getJSON()
  • To get the Application Owner Name, Application Link Name, Form Link Name and/ or View Link Name, please visit Creator API Link Names

Get Started Now

Execute