Get list of custom fields API in Zoho WorkDrive

Get List of Custom Fields

This API fetches all custom fields created within a data template.

Endpoints

get https://www.zohoapis.com/workdrive/api/v1/datatemplates/{data_template_id}/customfields

Copy full URL

OAuth Scope

WorkDrive.datatemplates.READCopied!

curl --request GET \
  --url https://www.zohoapis.com/workdrive/api/v1/datatemplates/{data_template_id}/customfields \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'

header = Map();
header.put("Accept","application/vnd.api+json");
response = invokeurl
[
url : "https://www.zohoapis.com/workdrive/api/v1/datatemplates/{data_template_id}/customfields"
type : GET
headers : header
connection : "wdconnection"
];
info response;

Path Parameters

data_template_idstring(Required)

A unique ID of the data template.

  {
    "data": [
      {
        "id": "nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDE",
        "type": "customfields",
        "attributes": {
          "data_template_id": "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001",
          "column_name": "CF60",
          "index": 0,
          "display_name": "Candidate Name",
          "type": "text",
          "field_properties": {
            "description": "Name of the candidate",
            "is_mandatory": true,
            "default_value": "",
            "max_char_length": "50"
          }
        },
        "links": {
          "self": "https://www.zohoapis.com/workdrive/api/v1/customfields/nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDE"
        }
      },
      {
        "id": "nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI",
        "type": "customfields",
        "attributes": {
          "data_template_id": "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001",
          "column_name": "CF61",
          "index": 1,
          "display_name": "Candidate Role",
          "type": "dropdown",
          "field_properties": {
            "description": "Role of the candidate",
            "is_mandatory": false,
            "default_value": ""
          },
          "choices": [
            {
              "key": "Developer"
            },
            {
              "key": "Designer"
            },
            {
              "key": "Marketer"
            }
          ]
        },
        "links": {
          "self": "https://www.zohoapis.com/workdrive/api/v1/customfields/nrkroc4c5f3259e2a410da17c3915ea990dde-MjQwMDAwMDA1ODEwMDEtMjQwMDAwMDA1ODIwMDI"
        }
      }
    ]
  }

▼ Show full