Get Records - Quick View

Overview
OpenAPI Specification
Request Details
Parameters
Defining the search criteria
Possible Errors

Overview

This API fetches the records displayed by a report of a Zoho Creator application. Its response will contain the data from the fields displayed in the report's quick view. A maximum of 200 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>/api/v2/<account_owner_name>/<app_link_name>/report/<report_link_name>

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.
demo_user_name	demouser_1, demouser_2, demouser_3..	Demo users in your Creator app can be appended along with the environment.

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

OAuth Scope

scope=ZohoCreator.report.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 target application
report_link_name	the link name of the target report

Parameters

fromint
(Optional) The starting index from which you want to fetch records.
limitint
(Optional) The number of records that you want the API request to fetch. The maximum is 200.
criteriastring
(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.

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.00	To fetch the records where the total (a currency field) is equal to 250.00
Total >= 100.00	To fetch the records where the total (a currency field) is greater than or equal to 100.00
Total < 50	To 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.00	To fetch the records where the status (a drop down field) is Open and Total (a currency field) is greater than 250.00
Product = 3888832000000113058	To 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=false	To 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://creator.zoho.com/api/v2/jason18/zylker-store/report/All_Orders?from=50&amp;limit=100"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

This sample request will fetch 100 records, from the 50th record, displayed by the All Orders report of the Zylker Store application.

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

Copiedcurl "https://creator.zoho.com/api/v2/jason18/zylker-store/report/All_Orders?from=50&amp;limit=100"
-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": [
    {
      "Multi_Line": "Multiples\nLines\nof Text",
      "Email": "p.boyle@zylker.com",
      "Address": {
        "display_value": "4154 High Meadow Lane, Scranton, PA, 18503, United States",
        "country": "United States",
        "district_city": "Scranton",
        "latitude": "41.4086874",
        "address_line_1": "4154 High Meadow Lane",
        "state_province": "PA",
        "address_line_2": "",
        "postal_code": "18503",
        "longitude": "-75.6621294"
      },
      "Phone_Number": "+15704961113",
      "Image": "/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114047/Image/download?filepath=1605793663692_image.jpg",
      "Url": {
        "value": "Zylker Inc",
        "url": "https://www.zylker.com"
      },
      "Name": {
        "display_value": "Mr. Jason Bowley Jr",
        "prefix": "Mr.",
        "last_name": "Bowley",
        "suffix": "Jr",
        "first_name": "Jason"
      },
      "Formula": "Single Line of Text - p.boyle@zylker.com",
      "Single_Line": "Single Line of Text",
      "Number": "12345",
      "Decimal": "20.43000",
      "Decision_box": "true",
      "File_upload": "/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114047/File_upload/download?filepath=1605793663645_file.csv",
      "Checkbox": "Choice 2",
      "Currency": "12.89",
      "Rich_Text": "<div><b>Rich</b> <i><span class=\"highlight\" style=\"background-color: rgb(254, 255, 51)\">Text</span></i> <u><span class=\"colour\" style=\"color: rgb(51, 51, 255)\">data</span></u>.<br /></div>",
      "Lookup": {
        "display_value": "asdasd",
        "ID": "3888833000000114027"
      },
      "ID": "3888833000000114047",
      "SubForm": [
        {
          "display_value": "Mekell",
          "ID": "3888833000000114043"
        }
      ],
      "Integration": {
        "display_value": "Webster",
        "ID": "3888833000000114007"
      },
      "Time_field": "10:30:00",
      "Multi_Select": [
        "Choice 2",
        "Choice 3"
      ],
      "Keyword": "Multiples Lines,Text",
      "Percent": "34.34",
      "Prediction": "",
      "Dropdown": "Choice 2",
      "Inline_SubForm": [
        {
          "display_value": "Barry",
          "ID": "3888833000000114037"
        }
      ],
      "Radio": "Choice 1",
      "Auto_Number": "2",
      "users": "jason18",
      "Sentiment": "Positive",
      "Date_Time": "24-Apr-2020 10:30:00",
      "Date_field": "24-Apr-2020",
      "Video": "",
      "Signature": "/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114047/Signature/download?filepath=1605793663691_signature.png",
      "Audio": "",
      "Object_Detection": "tv,laptop",
      "OCR": ""
    },
    {
      "Multi_Line": "Multiples\nLines\nof Text",
      "Email": "jason@zylker.com",
      "Address": {
        "display_value": "4154 High Meadow Lane, Scranton, PA, 18503, United States",
        "country": "United States",
        "district_city": "Scranton",
        "latitude": "41.4086874",
        "address_line_1": "4154 High Meadow Lane",
        "state_province": "PA",
        "address_line_2": "",
        "postal_code": "18503",
        "longitude": "-75.6621294"
      },
      "Phone_Number": "+15704961113",
      "Image": "/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114023/Image/download?filepath=1605793663687_image.jpg",
      "Url": {
        "value": "Zylker Inc",
        "url": "https://www.zylker.com"
      },
      "Name": {
        "display_value": "Mr. Jason Bowley Jr",
        "prefix": "Mr.",
        "last_name": "Bowley",
        "suffix": "Jr",
        "first_name": "Jason"
      },
      "Formula": "Single Line of Text - jason@zylker.com",
      "Single_Line": "Single Line of Text",
      "Number": "12345",
      "Decimal": "20.43000",
      "Decision_box": "true",
      "File_upload": "/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114023/File_upload/download?filepath=1605793663677_file.txt",
      "Checkbox": "Choice 1,Choice 2",
      "Currency": "1230.89",
      "Rich_Text": "<div><b>Rich</b> <i><span class=\"highlight\" style=\"background-color: rgb(254, 255, 51)\">Text</span></i> <u><span class=\"colour\" style=\"color: rgb(51, 51, 255)\">data</span></u>.<br /></div>",
      "Lookup": {
        "display_value": "asdasd",
        "ID": "3888833000000114027"
      },
      "ID": "3888833000000114023",
      "SubForm": [
        {
          "display_value": "Mekell",
          "ID": "3888833000000114019"
        }
      ],
      "Integration": {
        "display_value": "Webster",
        "ID": "3888833000000114007"
      },
      "Time_field": "10:30:00",
      "Multi_Select": [
        "Choice 2",
        "Choice 3"
      ],
      "Keyword": "Multiples Lines,Text",
      "Percent": "34.34",
      "Prediction": "",
      "Dropdown": "Choice 2",
      "Inline_SubForm": [
        {
          "display_value": "Barry",
          "ID": "3888833000000114013"
        }
      ],
      "Radio": "Choice 1",
      "Auto_Number": "1",
      "users": "jason18",
      "Sentiment": "Positive",
      "Date_Time": "24-Apr-2020 10:30:00",
      "Date_field": "24-Apr-2020",
      "Video": "/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114023/Video/download?filepath=1605793663694_videofile.mp4",
      "Signature": "/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114023/Signature/download?filepath=1605793663692_signature.png",
      "Audio": "/api/v2/jason18/zylker-store/report/All_Orders/3888833000000114023/Audio/download?filepath=1605793663693_audiofile.mp3",
      "Object_Detection": "tv,laptop",
      "OCR": "Cosy Homes\n             Upcoming Projects Report\n Upcoming Projects\nProject"
    }
  ]
}