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
Skip to main content

Get Records - v2.1

The functionality of this task can also be achieved using Get record - Quick View from API V2. But we suggest using API V2.1 for an updated experience.

Updates in V2.1:

1. New Parameters have been added:

  • record_cursor parameter key bulk fetches a batch of the consecutive 1000 records. 
  • field_config parameter key allows you to decide what fields of the records you want to be fetched. Possible values: quick_view, detail_view, custom, all.
  • fields parameter key defines the fields that need to be fetched when the custom value is parsed for field_config.
  • max_records parameter key decides the number of records that will be fetched per request.

2. Response Structures have been revised:

  • In API V2, the display_value of subform and lookup fields in the fetched response included space separated values. Along with this, in V2.1, they are included as key-value pairs in zc_display_value. This helps in efficient parsing of values further.
  • In API V2, all multivalue fields had the response structure as space separated values in a string. The response value structures for different fields in API V2.1 have been updated:
    • Multiselect, Checkbox: [list_value]
    • Single select lookup, Integration: {map}
    • Multiselect lookup: [{map1},{map2},{map3}...]

     This helps in efficient parsing of values further.

Overview

This API fetches the records displayed by a report. Its response will contain the data of all the visible fields present in the report's records. A maximum of 1000 records can be fetched per request.

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 Records - Quick View API below:

Request Details

Request URL 

https://<base_url>/creator/v2.1/data/<account_owner_name>/<app_link_name>/report/<report_link_name>

Request Method

GET

Header

KeyValueDescription
Authorization

Zoho-oauthtoken

1000.8cb99dxxxx

xxxxxxxxx9be93.9b

8xxxxxxxxxxxxxxxf

An authentication token (authtoken) allows users to access apps and APIs without having to enter their login credentials each time.
environmentdevelopment/stageRefers to the environment stage.
demo_user_name

demouser_1,

demouser_2,

demouser_3..

Demo users in your Creator app can be appended along with the environment.
record_cursor78S********p56Record cursor is an alpha numeric key. Every time records exist beyond the 1000 fetch count, a unique key will be received in the response header. This can be added in the header of the next API call to fetch the consecutive batch of 1000 records if they exist.
accept
  • application/json
  • text/csv
The format in which the API response is displayed.
Default value: application/json
Note: By default, production value will be considered for the environment header.

OAuth Scope 

ZohoCreator.report.READ
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_namethe username of the Creator account's owner
app_link_namethe link name of the target application
report_link_namethe link name of the target report

Parameters

  • criteria string

    (Optional)
    The criteria using which you want the API request to filter the target report. If not specified, the request will fetch the first 200 records from the report (as per its predefined sorting order). The sample input on the right sports a criteria that'll filter for records where the Single_Line field contains the value "Single Line of Text". Refer to the section below to learn more about defining the criteria.

Note: The criteria parameter cannot be used to filter records in an integration form's report.

  • field_config string

    (Optional)
    detail_view fetches only the fields included in the detailed view layout. quick_view fetches only the fields included in the quick view layout. custom fetches only the specified fields. all fetches the fields included both in the detailed view and quick view layout.

    Default value: quick_view

    Note:

    • This API will not fetch the records displayed in the related data blocks of the detail view.
    • If the key value is given as custom, the fields key should also be included in the header.
  • fields string

    (Optional)
    All the required fields' link names as individual comma-separated strings.

    Note: The field link names can be found in the field properties pane of each field in the form builder.
  • max_records int
    (Optional)
    The number of maximum records that will be fetched upon one request.
    Possible values: 200 (default value), 500, 1000 

    Note: For integration forms' reports, the maximum fetch count defined by the other service will be followed. Therefore, this parameter need not be included. If the number of records exceeds the defined limit, the record_cursor header key to fetch the next batch will be received in the response.

Defining the search criteria

  • The search criteria is a combination of one or more expressions. An expression is defined using a field, operator, and value.

  • An expression can use all field types except section and add notes. The field's data type dictates the operator that can be used and the format in which the value is to be given.

  • You can use logical operators && (AND) and || (OR) to link the expressions in your criteria. These operators are subject to precedence, which you can manage using parentheses ().

  • Values for STRING type fields, such as single line, email, and phone, must be enclosed in double-quotes.

  • Values for the time, date, and date-time fields must adhere to the application's date and time formats and must be enclosed in single-quotes.

  • The record ID must be passed when you want to filter the records using the lookup and integration fields.

  • When using the multi select, checkbox or multi-select lookup fields, you can specify only one value per expression.

Sample value for the parameter "criteria"Description
Name.last_name == "Boyle"To fetch the records where the last name is Boyle
Name.last_name != ""To fetch the records where the last name is not empty
Name.first_name.startsWith("Pat")To fetch the records where the first name starts with "pat", such as Patricia and Patrick
Email_Address.endsWith("zylker.com")To fetch the records where the email address ends with zylker.com
Feedback.contains("it's awesome")To fetch the records where the feedback (a multi line field) contains the phrase "it's awesome"
Total = 250.00To fetch the records where the total (a currency field) is equal to 250.00
Total >= 100.00To fetch the records where the total (a currency field) is greater than or equal to 100.00
Total < 50To fetch the records where the total (a decimal field) is less than 50
Appointment_Date = '13-Apr-2020'To fetch the records where the appointment date (a date field) is 13-Apr-2020 (as per the application's date format)
Appointment_Date >= '13-Apr-2020' && Appointment_Date <= '18-Apr-2020'To fetch the records where the appointment date (a date field) ranges from 13-Apr-2020 to 18-Apr-2020
Order_Status=="Open" || Order_Status=="In-progress"To fetch the records where the order status (a drop down or radio field) is either Open or In-progress
Status == "Open" && Total > 250.00To fetch the records where the status (a drop down field) is Open and Total (a currency field) is greater than 250.00
Product == 3888832000000113058To fetch the records where the product (a single-select lookup field) equals 3888832000000113058 (ID of a record present in the looked-up form)
Expedited_Delivery=falseTo fetch the records where the expedited delivery (a decision box field) is false
Hobbies.contains("Reading")To fetch the records where the hobbies (a multi select or checkbox field) includes reading
Hobbies="Reading" && Hobbies="Hiking"To fetch the records where the hobbies (a multi select or checkbox field) are reading and hiking

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/data/jason18/zylker-store/report/All_Orders"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedtry
{
	response = invokeUrl
	[
		url: "https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/All_Orders?max_records=200&criteria=Single_Line%20%3D%3D%20%22Single%20Line%20of%20Text%22&field_config=custom&fields=Single_Line%2CNumber"
		type: GET
		connection: "creatorconnection"
	];
}
catch(e)
{
	info "Exception while making the API request." ;
}
Copiedpackage org.example;

import okhttp3.HttpUrl;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import org.json.JSONObject;

public class GetRecords
{
    public static void main(String[] args)
    {
        OkHttpClient client = new OkHttpClient();

        HttpUrl.Builder urlBuilder = HttpUrl.parse("https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/All_Orders").newBuilder()
                .addQueryParameter("max_records", "200")
                .addQueryParameter("criteria", "Single_Line == \"Single Line of Text\"")
                .addQueryParameter("field_config","custom")
                .addQueryParameter("fields","Single_Line,Number");
        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/data/jason18/zylker-store/report/All_Orders?max_records=200&criteria=Single_Line%20%3D%3D%20%22Single%20Line%20of%20Text%22&field_config=custom&fields=Single_Line%2CNumber", {
        method: "GET",
        headers: api_headers
    })
}
catch (exception) {
    console.error(exception)
}
Copiedimport requests

api_parameters = {
    "max_records": "200",
    "criteria": "Single_Line == \"Single Line of Text\"",
    "field_config": "custom",
    "fields": "Single_Line,Number"
}

api_headers = {
    "Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}

try:
    response = requests.get("https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/All_Orders", params=api_parameters, headers=api_headers)
except:
    print("Exception while making the API request.")

This sample request will fetch the first 1000 records displayed by the All Orders report of the Zylker Store application.

Sample Request for Development/ Stage environments (for C6 users)

Copiedcurl "https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/All_Orders"
-X GET 
-H 'Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf'  
-H 'environment: development'
-H 'demo_user_name: demouser_1'

Sample Response: All field types

Copied{
  "code": 3000,
  "data": [
    {
      "ID": "52129000008009043",
      "Single_Line": "Warehouse",
      "Email": "John@Lord.com",
      "Currency": "1234723.90",
      "Name": {
        "zc_display_value": "John Lord",
        "prefix": "",
        "last_name": "Lord",
        "suffix": "",
        "first_name": "John"
      },
      "Address": {
        "zc_display_value": "6, West Street, Phoenix, Phoenix, Arizona, 20532, USA",
        "country": "USA",
        "district_city": "Phoenix",
        "address_line_1": "6, West Street",
        "state_province": "Arizona",
        "address_line_2": "Phoenix",
        "postal_code": "20532"
      },
      "Image": "/api/v2.1/christinaclover/import/report/sample_report/52129000008009043/Image/download?filepath=1681379407888_John.jpeg",
      "test_ss": {
        "zc_display_value": "52129000008009170 - 13-Apr-2023 17:21:24 - christinaclover",
        "Added_User": "christinaclover",
        "ID": "52129000008009170",
        "Added_Time": "13-Apr-2023 17:21:24"
      },
      "test_ss.Single_Line": "Portia",
      "test_ss.Name": {
        "zc_display_value": "Portia Lance",
        "prefix": "",
        "last_name": "Lance",
        "suffix": "",
        "first_name": "Portia"
      },
      "test_ms": [
        {
          "zc_display_value": "52129000008009051 - christinaclover - John - 13-Apr-2023 16:59:29",
          "Modified_Time": "13-Apr-2023 16:59:29",
          "Added_User": "christinaclover",
          "ID": "52129000008009051",
          "Name.first_name": "John"
        },
        {
          "zc_display_value": "52129000008009170 - christinaclover - Portia - 13-Apr-2023 18:03:05",
          "Modified_Time": "13-Apr-2023 18:03:05",
          "Added_User": "christinaclover",
          "ID": "52129000008009170",
          "Name.first_name": "Portia"
        }
      ],
      "test_ms.Single_Line": [
        "test",
        "Portia"
      ],
      "test_ms.Name": [
        {
          "zc_display_value": "John Lord",
          "prefix": "",
          "last_name": "Lord",
          "suffix": "",
          "first_name": "John"
        },
        {
          "zc_display_value": "Portia Lance",
          "prefix": "",
          "last_name": "Lance",
          "suffix": "",
          "first_name": "Portia"
        }
      ],
      "SubForm": [
        {
          "zc_display_value": "John Lord 220B, Baker Street, London, London, 13455, United Kingdom 10-Apr-2023 52129000008009051 52129000008009051, 52129000008009084",
          "Date_field": "10-Apr-2023",
          "Address": {
            "zc_display_value": "220B, Baker Street, London, London, 13455, United Kingdom",
            "country": "United Kingdom",
            "district_city": "London",
            "address_line_1": "220B, Baker Street",
            "state_province": "London",
            "address_line_2": "",
            "postal_code": "13455"
          },
          "test": {
            "zc_display_value": "52129000008009051",
            "ID": "52129000008009051"
          },
          "test_ms": [
            {
              "zc_display_value": "52129000008009051",
              "ID": "52129000008009051"
            },
            {
              "zc_display_value": "52129000008009084",
              "ID": "52129000008009084"
            }
          ],
          "ID": "52129000008009023",
          "Name": {
            "zc_display_value": "John Lord",
            "last_name": "Lord",
            "first_name": "John"
          }
        },
        {
          "zc_display_value": "    ",
          "Date_field": "",
          "Address": {
            "zc_display_value": "",
            "country": "",
            "district_city": "",
            "address_line_1": "",
            "state_province": "",
            "address_line_2": "",
            "postal_code": ""
          },
          "test": {},
          "test_ms": [],
          "ID": "5213456789000987"
        }
      ],
      "Users_MS": [
        "christinaclover",
        "manish.koothrapalli"
      ]
    }
  ]
}