Creator API

REST API - List Applications

URL

To list all applications:

https://creator.zoho.com/api/<format>/applications/

To list applications shared by other users:

https://creator.zoho.com/api/<format>/sharedapps/

where <format> is the type of response format as listed below.

Formats

xml, json

HTTP Method

GET

Parameters

Parameter Name Usage Description
authtoken Required. A valid API authtoken. Refer https://api.creator.zoho.com/Generate-Auth-Token.html for generating authtoken.
scope Required Specify the value as creatorapi
limit Optional. Number of applications to list.

Prerequisites

Notes

    • The owner can see all the applications, other users can only see public applications.
      • Only the owner can see shared applications.

Sample Request

<form method="GET" action="https://creator.zoho.com/api/xml/applications">

<input type="hidden" name="limit" value="20" />

<input type="hidden" name="authtoken" value="" />

<input type="hidden" name="scope" id="scope" value="creatorapi" />

<input type="submit" value="List applications" />

</form>

Sample Response

XML response

<?xml version="1.0" encoding="UTF-8" ?>
<result>
<application_owner>zohocreator</application_owner>
<application_list>
<applications>
<application>
<access>private</access>
<link_name>feedback-application</link_name>
<application_name>Feedback Application</application_name>
<created_time>2007-09-05 19:53:46.0</created_time>
</application>
<application>
<access>private</access>
<link_name>recruitment</link_name>
<application_name>Recruitment</application_name>
<created_time>2007-09-04 16:39:22.0</created_time>
</application>
</applications>
</application_list>
</result>

JSON response

{"result":{"application_owner":"zohocreator","application_list":{"applications":[{"application":[{"access":"private","link_name":"feedback-application","application_name":"Feedback Application","created_time":"2007-09-05 19:53:46.0"},{"access":"private","link_name":"recruitment","application_name":"Recruitment","created_time":"2007-09-04 16:39:22.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