Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Writer Documents API

Create, upload, list, download, and inspect documents

Zoho Writer Documents API is one of 5 APIs that Zoho Writer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 9 base URLs: https://www.zohoapis.com/writer/api/v1, https://www.zohoapis.eu/writer/api/v1, https://www.zohoapis.in/writer/api/v1, https://www.zohoapis.jp/writer/api/v1, https://www.zohoapis.com.au/writer/api/v1, https://www.zohoapis.ca/writer/api/v1, https://www.zohoapis.sa/writer/api/v1, https://www.zohoapis.com.cn/writer/api/v1, https://www.zohoapis.sg/writer/api/v1.

5 operations 4 paths 7 schemas 4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://writer.zoho.com/api/v1
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Zoho Writer Documents API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 6 scopes. By default, every request must be authenticated.

  • OAuth2 — OAuth 2.0 authentication. Refer to https://www.zoho.com/writer/help/api/v1/oauth-2.html for setup.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 5

Create, upload, list, download, and inspect documents

GET
/documents
Get list of documents
listDocuments → 200401
POST
/documents
Create or upload a document
createDocument body → 200400401
GET
/documents/{document_id}
Get document details
getDocument 1 param → 200404
GET
/documents/{document_id}/metrics
Get document metrics
getDocumentMetrics 1 param → 200404
GET
/download/{document_id}
Download a document
downloadDocument 5 params → 200404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are DocumentSummary (12 properties), UserInfo (4 properties), DocumentMetrics (3 properties), Permissions (3 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties
Permissions
object
3 properties
ParentInfo
object
2 properties
UserInfo
object
4 properties
DocumentMetrics
object
3 properties
DocumentSummary
object
12 properties
DocumentDetails

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-writer-documents-api-openapi.yml Raw ↑

Other APIs Zoho Writer publishes across the network.

Zoho Writer API
Zoho Writer Combine API
Zoho Writer Merge API
Zoho Writer Signatures API