Get Document Fields

Retrieves all fields present in a document, categorized by type: fillable fields (fill), merge fields (merge), and signature fields (sign).

Endpoints

get https://www.zohoapis.com/writer/api/v1/documents/{document_id}/fields

Copy full URL

OAuth Scope

ZohoWriter.documentEditor.ALL, WorkDrive.files.ALL, WorkDrive.organization.ALL, WorkDrive.workspace.ALLCopied!

curl --request GET \
  --url https://www.zohoapis.com/writer/api/v1/documents/a1b2c3d4e5f6g7h8i9/fields \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://www.zohoapis.com/writer/api/v1/documents/{document_id}/fields"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

Path Parameters

document_idstring(Required)

The unique ID of the document.

  {
    "fill": [
      {
        "formats": {
          "lookup": true,
          "watch": {
            "fields": [
              {
                "id": ""
              }
            ]
          },
          "uncheckedValue": "",
          "checkedValue": "",
          "maxLength": 30
        },
        "name": "User name",
        "id": "",
        "type": "singleline",
        "value": "Amelia"
      }
    ],
    "merge": [
      {
        "id": "Name",
        "display_name": "Name",
        "type": "text",
        "fields": [
          {
            "id": "Products.Products_name",
            "display_name": "Products.Products Name",
            "type": "text"
          }
        ]
      }
    ],
    "sign": {
      "Recipient1": {
        "job_title": "",
        "Agree_term_and_conditions": ""
      },
      "Recipient2": {
        "company_name": "",
        "Address": ""
      }
    }
  }

▼ Show full