Get All Fields

Purpose 

To get all the available fields present in the document.

HTTP Request URL

https://{zohoapis_domain}/writer/api/v1/documents/{{document_id}}/fields

Path Parameters

ParameterData TypeDescription
Mandatory Parameters
document_idStringSpecify a unique id for the writer document.

Note:

  • If there are no signer fields present in the Writer document for a recipient, an empty JSON will be returned for that recipient.
  • You can also fetch the list of all the fields inserted into a Zoho Writer document using this deluge task.

Sample Request

CurlDeluge
Copiedcurl --location --request GET "https://www.zohoapis.com/writer/api/v1/documents/ponazfea04477109f4681a831e7177d96bc40/fields" \
  --header "Authorization: Zoho-oauthtoken xxx.yyy.zzz"
Copieddocument_id = "ponazfea04477109f4681a831e7177d96bc40";
getAllFieldsResponse = invokeurl
[
	url: "https://writer.zoho.com/api/v1/documents/"ponazfea04477109f4681a831e7177d96bc40/fields"
	type: GET
	connection: <connection_name>
];
info getAllFieldsResponse;

Sample Response

Copied{
 "fill": [
        {
            "formats": {
		"lookup": true,
                "watch": {"fields":[{"id":""}]},
	        "uncheckedValue": "",
                "checkedValue": "",
                "maxLength": 30
            },
            "name": "User name",
            "id": "",
            "type": "singleline",
            "value":"Amelia"
        },
        {
            "formats": {
		"lookup": true,
                "watch": {"fields":[{"id":""}]},
                "numberFormat": "0",
                "locale": "en-GB",
                "maxLength": 10
            },
            "name": "Student Id",
            "id": "",
            "type": "number",
            "value":"9876"
        },
        {
            "formats": {
                "lookup": true,
                "watch": {"fields":[{"id":""}]},
                "maxLength": 30
            },
            "name": "E-Mail Id",
            "id": "",
            "type": "email",
            "value":"amelia@zylker.com"
        },
        {
            "formats": {
                "lookup": true,
                "watch": {"fields":[{"id":""}]},
                "format": "DD/MM/YYYY",
                "locale": "en-GB",
                "maxLength": 30
            },
            "name": "Date of Birth",
            "id": "",
            "type": "date",
            "value":"01/01/2000"
        },
        {
            "formats": {
                "lookup": true,
                "watch": {"fields":[{"id":""}]},
                "maxLength": 10
            },
            "name": "Phone Number",
            "id": "",
            "type": "phone",
            "value":"9876543210"
        },
        {
            "formats": {
                "lookup": true,
                "watch": {"fields":[{"id":""}]},
                "numberFormat": "0%",
                "locale": "en-GB",
                "maxLength": 10
            },
            "name": "CGPA",
            "id": "",
            "type": "percent",
            "value":"80%"
        },
        {
            "formats": {
                "lookup": true,
                "watch": {"fields":[{"id":""}]},
                "useCurrencySymbol": true,
                "currencySymbol": "£",
                "locale": "en-GB",
                "currencyISOCode": "GBP",
                "maxLength": 20
            },
            "name": "Student Fees",
            "id": "",
            "type": "currency",
            "value":"£200"
        },
        {
            "formats": {
                "lookup": true,
                "watch": {"fields":[{"id":""}]},
                "list": [
                    "Biology",
                    "Computer Science",
                    "Accountancy"
                ],
                "selectedIndex": 0
            },
            "name": "Courses",
            "id": "",
            "type": "selectbox",
            "value":"Biology"
        },
        {
            "formats": {
                "size": 20,
                "uncheckedValue": "False",
                "checkedValue": "True",
                "checked": false
            },
            "name": "First graduate",
            "id": "",
            "type": "checkbox",
            "value":"☐"
        },
        {
            "formats": {
                "checked": false,
                "value" :"Male"
            },
            "name": "Gender",
            "id": "",
            "type": "radio",
            "value":"○"
        },
        {
            "formats": {
                "checked": false,
	        "value" :"Female"
            },
            "name": "Gender",
            "id": "",
            "type": "radio",
            "value":"○"
        }

    ]
,
  "merge": [
    {
      "id": "Name",
      "display_name": "Name",
      "type": "text"
    },
    {
      "id": "Email",
      "display_name": "Email",
      "type": "email"
    },
    {
      "id": "Products",
      "display_name": "Products",
      "type": "related_list",
      "fields": [
        {
          "id": "Products.Products_name",
          "display_name": "Products.Products Name",
          "type": "text"
        },
        {
          "id": "Products.Products_code",
          "display_name": "Products.Products Code",
          "type": "number"
        },
        {
          "id": "Products.Products_category",
          "display_name": "Products.Products Category",
          "type": "text"
        }
      ]
    },
    {
      "id": "Mobile",
      "display_name": "Mobile",
      "type": "number"
    }
  ],
  "sign": {
    "Recipient1": {
      "job_title": "",
      "Agree_term_and_conditions": ""
    },
    "Recipient2": {
      "company_name": "",
      "Address": ""
    }
  }
}