Workspace API

Manage workspace and organization information related to the account. List all available workspaces and organizations associated with the account in WorkDrive.

Data Center:

⬇ Download OpenAPI Spec

GET List Workspaces

GET https://show.zoho.com/api/v1/workspace

Required Scopes:

ZohoShow.showdocslist.READ WorkDrive.organization.READ WorkDrive.team.READ

Fetches data about all of the user's workspaces, organizations, and team editions.

Query parameters

Name	Type	Required	Description
fields	string	Optional	Comma-separated response fields to include. Allowed values: team_id, team_uid, name, type, product, product_type, product_domain, wd_edition, bundle_id, integration, library_client_type, client_zsoid, is_current_user_wd_admin, is_current_user_super_admin, is_family_premium_edition, super_admin_contact, display_status, has_library. Note: some names differ from the unfiltered response body — use wd_edition (not edition), library_client_type (not client_type), is_current_user_wd_admin (not is_current_user_admin), and super_admin_contact (not superadmin_contact).
is_default	boolean	Optional	When true, returns only your default workspace. Omit or set to false to return all workspaces you can access.

Samples

Responses

200 Get All Workspaces (Fields)

200 Get Current Workspace

200 Get All Workspaces

200 Get Current Workspace (Fields)

{
  "data": {
    "workspaces": [
      {
        "name": "Zoho Show",
        "team_id": "93601174"
      },
      {
        "name": "Notify-Team",
        "team_id": "94019985"
      }
    ]
  },
  "message": "Getting workspace list",
  "request_uri": "/api/v1/workspace",
  "status": "success"
}

{
  "data": {
    "workspaces": [
      {
        "product": "TEAMDRIVE",
        "has_library": true,
        "library_sid": "93607026",
        "product_domain": "workdrive.zoho.com",
        "edition": "TEAM",
        "client_type": "3",
        "team_id": "93601174",
        "is_default": true,
        "is_current_user_admin": true,
        "product_type": "1",
        "supported_libraries": [
          "ORG_LIBRARY"
        ],
        "client_zsoid": "20zea57dcfde08aae417faf9296501dd17a82",
        "bundle_id": "-1",
        "name": "Zoho Show",
        "integration": "WORKDRIVE",
        "is_family_premium_edition": false,
        "superadmin_contact": "user@example.com",
        "team_uid": "20zea57dcfde08aae417faf9296501dd17a82",
        "org_library": {
          "user_role": "SUPER_ADMIN",
          "is_font_library_enabled": true,
          "library_id": "107004000000005001",
          "client_display_name": "Zoho Show",
          "library_type": "1"
        },
        "is_current_user_super_admin": true
      },
      {
        "product": "TEAMDRIVE",
        "has_library": true,
        "library_sid": "105588816",
        "product_domain": "workdrive.zoho.com",
        "edition": "TEAM",
        "client_type": "3",
        "team_id": "94019985",
        "is_default": false,
        "is_current_user_admin": false,
        "product_type": "1",
        "supported_libraries": [
          "ORG_LIBRARY"
        ],
        "client_zsoid": "yn4zb37bb45b2dc6d4966a9136b332198d681",
        "bundle_id": "-1",
        "name": "Notify-Team",
        "integration": "WORKDRIVE",
        "is_family_premium_edition": false,
        "superadmin_contact": "user@example.com",
        "team_uid": "yn4zb37bb45b2dc6d4966a9136b332198d681",
        "org_library": {
          "user_role": "VIEWER",
          "is_font_library_enabled": false,
          "library_id": "130054000000005001",
          "client_display_name": "Notify-Team",
          "library_type": "1"
        },
        "is_current_user_super_admin": false
      }
    ]
  },
  "message": "Getting workspace list",
  "request_uri": "/api/v1/workspace",
  "status": "success"
}

Code Examples

cURL

curl -X GET "https://show.zoho.com/api/v1/workspace?fields=name,team_id&is_default=true" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch('https://show.zoho.com/api/v1/workspace?fields=name,team_id&is_default=true', {
  method: 'GET',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://show.zoho.com/api/v1/workspace?fields=name,team_id&is_default=true'),
  method: 'GET',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.end();

Python

import requests

url = "https://show.zoho.com/api/v1/workspace?fields=name,team_id&is_default=true"
headers = {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://show.zoho.com/api/v1/workspace?fields=name,team_id&is_default=true"))
            .header("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .timeout(Duration.ofSeconds(30));

            .header("Content-Type", "application/json")
        HttpRequest request = requestBuilder
            .GET(HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://show.zoho.com/api/v1/workspace?fields=name,team_id&is_default=true";

headers = Map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

response = invokeurl
[
    url: "https://show.zoho.com/api/v1/workspace?fields=name,team_id&is_default=true"
    type: GET
    headers: headers
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}