Get Applications by Workspace

Table of Contents

Overview

This API fetches the meta information of the applications hosted in a given workspace that you have access to.

  • Each Zoho Creator account has its own workspace—the digital space where apps are created and hosted
  • You can award your users the permission to create apps in your workspace, and vice versa
  • Refer to this section to learn about the application categories

Request Details

Request URL

https://<base_url>/creator/v2.1/meta/<account_owner_name>/applications

Request method

GET

Header

KeyValueDescription
Authorization

Zoho-oauthtoken

1000.8cb99dxxxxx

xxxxxxxx9be93.9b

8xxxxxxxxxxxxxxxf

An authentication token (authtoken) allows users to access apps and APIs without having to enter their login credentials each time.

OAuth scope

scope=ZohoCreator.dashboard.READ

where,

base_urlthe 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

Application Categories

  • Category 1 are applications that are hosted in the requesting user's workspace
  • Category 2 are applications that are hosted in a workspace other than that of the requesting user

Possible Errors

Refer to this page for the list of error codes and messages.

Sample Request

CurlDelugeJavaJavaScriptPython
Copiedcurl "https://www.zohoapis.com/creator/v2.1/meta/megan9/applications"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url :"https://www.zohoapis.com/creator/v2.1/meta/jason18/applications"
	type :GET
	connection:"zoho-creator"
];
info response;
Copiedpackage main.java.org.example;

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

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

        HttpUrl.Builder urlBuilder = HttpUrl.parse("https://www.zohoapis.com/creator/v2.1/meta/jason18/applications").newBuilder();
        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/meta/jason18/applications", {
        method: "GET",
        headers: api_headers
    })
}
catch (exception) {
    console.error(exception)
}
Copiedimport requests

api_headers = {
    "Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
try:
    response = requests.get("https://www.zohoapis.com/creator/v2.1/meta/jason18/applications", headers=api_headers)
except:
    print("Exception while making the API request.")

This sample request will fetch the meta information of all applications that the requesting user has access to, in the workspace named megan9.

Sample Response

Copied{
  "code": 3000,
  "applications": [
    {
      "application_name": "Zylker Store",
      "date_format": "MMM dd,yyyy",
      "creation_date": "20-Apr-2020 16:23:50",
      "link_name": "zylker-store",
      "category": 2,
      "time_zone": "SystemV/PST8",
      "created_by": "",
      "workspace_name": "megan9"
    },
    {
      "application_name": "Zylker Self-Service",
      "date_format": "MM-dd-yyyy",
      "creation_date": "30-Sep-2019 02:21:51",
      "link_name": "zylker-self-service",
      "category": 2,
      "time_zone": "America/Los_Angeles",
      "created_by": "",
      "workspace_name": "megan9"
    }
  ]
}