Creator API

REST API - View Records in View

URL

https://creator.zoho.com/api/<format>/<applicationName>/view/<viewName>

where <applicationName> and <viewName> are the link names of your application and view as can be referred to here
and <format> is the type of response format as listed below.

Formats

xml, csv, json

HTTP Method

GET

Parameters

Parameter Name Usage Description
authtoken Required. A valid API authtoken. Referhttps://api.creator.zoho.com/Generate-Auth-Token.htmlfor generating authtoken.
scope Required Specify the value as creatorapi
<application name> Required. The name of the application that contains the form.
<view name> Required The name of the view to show records from.
zc_ownername Optional. The owner of the application. Required if the application is being accessed by a shared or public user.
raw Optional If response format is specified as json set this parameter to true to get only a json array without a Javascript variable.
criteria Optional

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")

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

Prerequisites

Notes

  • 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> (eg: Department.Department_Name)

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 ="scope" id="scope" value="creatorapi">
<input type="submit" value="View Records">
</form>

Sample Response

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"}]}

CSV response

Name,DOB,Address,Hobbies,Basic Juliet,14-Jul-1989,France,"[Reading, Swimming]",33000.0 Gary,12-Jun-1980,India,[Swimming],35000.0 Jean,20-Jul-1981,UK,"[Running, Swimming]",32000.0

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 for the list of error codes. If the operation is successful, the response message will be displayed with status as "Success".

Top