View Records

    REST API v1 - View Records

    • Zoho Creator's v1 APIs will reach their end-of-life on February 3rd, 2021. We strongly recommend you to migrate to the new v2 APIs. Refer to this post to learn more.
    • Accounts in Zoho's Australia data center (.com.au) can only use Creator's v2 APIs
    • Corresponding v2 APIs: Get Records - Quick View and Get Record - Detail View

    Table of Contents

    URL

    https://creator.zoho.com/api/<format>/<applicationLinkName>/view/<viewLinkName>

    where,

    <applicationName>  and <viewLinkName>These are the link name of your application and view or report, respectively. These can be be referred from here.
    <format>This is the type of response format, as listed below.

    Formats

    • xml
    • json

    HTTP Method

    GET

    Parameters

    Parameter NameUsageDescription
    authtokenRequiredA valid API authtoken. Refer this page to generate authtoken.
    scopeRequiredSpecify the value as creatorapi
    <application link name>RequiredThe link name of the application that contains the form.
    <view link name>RequiredThe link name of the view/report to display the records from.
    zc_ownernameRequiredThe owner of the application. 
    rawOptionalIf response format is specified as json set this parameter to true to get only a json array without a Javascript variable.
    criteriaOptional

    The criteria must be specified in the format <criteria column name> <operator> <value>
    where <criteria column name> is the link name of the field to check <value> against
    and <operator> is the operator to use. Some of the expamples for the operators supported are
    !=, <=, >=,<, >, ==

    Example : (Name == "Jean" && DOB == "20-Jul-1981")
    Note: The target report's criteria will automatically be applied when this API endpoint is accessed.
    startindexOptionalThe starting index of the range of records to be viewed (pagination purpose)
    limitOptionalThe end index of the range of records to be viewed (pagination purpose)

    Refer to this page for the link names used in your applications.

    Prerequisites

    • A valid AuthToken
    • Please ensure that you've enabled the API accesspermission for the required users. It's enabled by default. It determines if the user is allowed to use your Creator application's APIs.

    Notes

    • The target report's criteria will automatically be applied when this API endpoint is accessed.
    • Anyone with a valid auth token can view the records of a public Form.
    • Only the owner of the application can view the records of a private Form.
    • Any user with a valid auth token and share permission can view the records of a shared Form.
    • Lookup related fields are listed as <Lookup Field Name>.<Actual Field Name> . For example, Department.Department_Name.
    • In accounts using Zoho Creator 5:
      • This API 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

    Sample Request

    <form method="GET" action="https://creator.zoho.com/api/xml/sample/view/Employee_View">
    <input type="hidden" name ="authtoken" value="************">
    <input type="hidden" name ="zc_ownername" value="********">
    <input type="hidden" name="criteria" value='(PacienteSL=="Abilio Alfredo Finotti")'>
    <input type="hidden" name ="scope" id="scope" value="creatorapi">
    <input type="submit" value="View Records">
    </form>

    Sample Response

    Note: In accounts using Zoho Creator 5:
    • This API 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

    XML response

    <?xml version="1.0" encoding="UTF-8" ?>
    <response>
    <records>
    <record id="8007000006281183">
    <column name="Name">
    <value>Juliet</value>
    </column>
    <column name="DOB">
    <value>14-Jul-1989</value>
    </column>
    <column name="Address">
    <value>France</value>
    </column>
    <column name="Hobbies">
    <value>[Reading, Swimming]</value>
    </column>
    <column name="Basic">
    <value>33000.0</value>
    </column>
    </record>
    <record>
    <column name="Name">
    <value>Gary</value>
    </column>
    <column name="DOB">
    <value>12-Jun-1980</value>
    </column>
    <column name="Address">
    <value>India</value>
    </column>
    <column name="Hobbies">
    <value>[Swimming]</value>
    </column>
    <column name="Basic">
    <value>35000.0</value>
    </column>
    </record>
    <record>
    <column name="Name">
    <value>Jean</value>
    </column>
    <column name="DOB">
    <value>20-Jul-1981</value>
    </column>
    <column name="Address">
    <value>UK</value>
    </column>
    <column name="Hobbies">
    <value>[Running, Swimming]</value>
    </column>
    <column name="Basic">
    <value>32000.0</value>
    </column>
    <column name="Department.Role">
    <value>Finance</value>
    </column>
    </record>
    </records>
    </response>

    JSON response

    {"Employee":[{"Address":"France","Hobbies":"[Reading, Swimming]","Basic":33000,"Name":"Juliet","DOB":"14-Jul-1989"},{"Address":"India","Hobbies":"[Swimming]","Basic":35000,"Name":"Gary","DOB":"12-Jun-1980"},{"Address":"UK","Hobbies":"[Running, Swimming]","Basic":32000,"Name":"Jean","DOB":"20-Jul-1981"}]}

    Error Codes

    If there is an error in the request format, the corresponding error code with error message will be displayed. Please refer to the topic Error codes and descriptions to know about them. If the operation is successful, the response message will be displayed with status as "Success".

    Share this post : FacebookTwitter

    Still can't find what you're looking for?

    Write to us: support@zohocreator.com