{ "openapi": "3.0.3", "info": { "title": "Zoho Sign API", "version": "1.0", "description": "Digital signature API for sending, signing, and managing documents.", "x-jentic-source-url": "https://www.zoho.com/sign/api/", "contact": { "name": "Zoho Sign API Support" } }, "servers": [ { "url": "https://sign.zoho.com/api/v1" } ], "paths": { "/accounts": { "get": { "operationId": "getAccounts", "summary": "Get account info", "tags": ["Accounts"], "responses": { "200": {"description": "Successful response"}, "400": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}}, "401": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}} }, "description": "Get account info" } }, "/users": { "get": { "operationId": "listUsers", "summary": "List users", "tags": ["Users"], "parameters": [ {"name": "row_count", "in": "query", "required": false, "schema": {"type": "integer"}}, {"name": "start_index", "in": "query", "required": false, "schema": {"type": "integer"}}, {"name": "sort_column", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "sort_order", "in": "query", "required": false, "schema": {"type": "string"}} ], "responses": { "200": {"description": "Successful response"}, "400": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}}, "401": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}} }, "description": "List users" } }, "/requests": { "get": { "operationId": "listRequests", "summary": "List document requests", "tags": ["Requests"], "parameters": [ {"name": "row_count", "in": "query", "required": false, "schema": {"type": "integer"}}, {"name": "start_index", "in": "query", "required": false, "schema": {"type": "integer"}}, {"name": "sort_column", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "sort_order", "in": "query", "required": false, "schema": {"type": "string"}} ], "responses": { "200": {"description": "Successful response"}, "400": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}}, "401": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}} }, "description": "List document requests" }, "post": { "operationId": "createRequest", "summary": "Create document request", "tags": ["Requests"], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"requests": {"type": "object"}}}}}}, "responses": { "201": {"description": "Created"}, "400": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}}, "401": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}} }, "description": "Create document request" } }, "/requests/{request_id}": { "get": { "operationId": "getRequest", "summary": "Get document request", "tags": ["Requests"], "parameters": [{"name": "request_id", "in": "path", "required": true, "schema": {"type": "string"}}], "responses": { "200": {"description": "Successful response"}, "400": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}}, "401": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}} }, "description": "Get document request" }, "put": { "operationId": "updateRequest", "summary": "Update request", "tags": ["Requests"], "parameters": [{"name": "request_id", "in": "path", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"requests": {"type": "object"}}}}}}, "responses": { "200": {"description": "Successful response"}, "400": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}}, "401": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}} }, "description": "Update request" }, "delete": { "operationId": "deleteRequest", "summary": "Delete request", "tags": ["Requests"], "parameters": [{"name": "request_id", "in": "path", "required": true, "schema": {"type": "string"}}], "responses": { "200": {"description": "Successful response"}, "400": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}}, "401": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}} }, "description": "Delete request" } }, "/templates": { "get": { "operationId": "listTemplates", "summary": "List templates", "tags": ["Templates"], "responses": { "200": {"description": "Successful response"}, "400": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}}, "401": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}} }, "description": "List templates" } }, "/templates/{template_id}": { "get": { "operationId": "getTemplate", "summary": "Get template", "tags": ["Templates"], "parameters": [{"name": "template_id", "in": "path", "required": true, "schema": {"type": "string"}}], "responses": { "200": {"description": "Successful response"}, "400": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}}, "401": {"description": "Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ErrorResponse"}}}} }, "description": "Get template" } } }, "components": { "schemas": { "ErrorResponse": { "type": "object", "properties": { "status": {"type": "string"}, "code": {"type": "string"}, "message": {"type": "string"} } } }, "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "tokenUrl": "https://accounts.zoho.com/oauth/v2/token", "scopes": { "ZohoSign.documents.ALL": "All document operations", "ZohoSign.templates.ALL": "All template operations", "ZohoSign.account.ALL": "Account operations" } } } } } }, "security": [{"oauth2": []}], "tags": [ {"name": "Accounts"}, {"name": "Requests"}, {"name": "Templates"}, {"name": "Users"} ] }