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

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 Applications by Workspace API below:

Request Details

Request URL

https://<base_url>/api/v2/<account_owner_name>/applications

Request method

GET

Header

KeyValueDescription
AuthorizationZoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxfAn 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_urlZoho 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_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

Copiedcurl "https://creator.zoho.com/api/v2/megan9/applications"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

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