Zoho Sign icon

Zoho Sign

Interact with the Zoho Sign API

Actions25

Document → Get

AI-generated

Summary

Retrieve detailed information about a specific document signing request using its Request ID, optionally simplifying or formatting the output for use in updates.

Inputs

  • Request ID (required) — The Request ID associated with the specific document signing request to retrieve.
  • Simplify Output (required) — A boolean indicating whether to return a simplified subset of the document data or the full detailed response.
  • Format Actions (required) — A boolean indicating whether to format the actions array in the response for use in an 'Update' operation.

Output shape

a single record containing document signing request details including status, owner info, documents, and actions.

If 'Simplify Output' is enabled, returns a limited subset of fields including request_status, owner_id, request_name, is_deleted, modified_time, document_ids array, request_id, request_type_id, and a simplified actions array. If 'Format Actions' is enabled, the actions are sanitized and formatted with placeholder values to use as a template for 'Update' operation input.

Examples

Example 1: Retrieve full document details by Request ID

Set 'Request ID' to the target ID, disable 'Simplify Output' and 'Format Actions', then run the node to get complete document details including all fields and metadata.

Example 2: Fetch simplified document details

Set 'Request ID', enable 'Simplify Output' to get essential document info, and disable 'Format Actions'. Returns a compact JSON with key summary fields for easier handling in workflows.

Example 3: Get formatted actions for updating a document request

Set 'Request ID', enable 'Format Actions' to receive a formatted actions array with placeholder email and name values suitable for reuse in 'Update' operations.

Links

Discussion