Get custom document fields from template

GET

/v2/accounts/:accountId/templates/:templateId/custom_fields

GET

/restapi/v2/accounts/:accountId/templates/:templateId/custom_fields

curl https://demo.docusign.net/restapi/v2/accounts/accountId/templates/templateId/custom_fields \
     -H "Authorization: <apiKey>"

{
  "listCustomFields": [
    {
      "configurationType": "string",
      "errorDetails": {
        "errorCode": "string",
        "message": "string"
      },
      "fieldId": "string",
      "listItems": [
        "string"
      ],
      "name": "string",
      "required": "string",
      "show": "string",
      "value": "string"
    }
  ],
  "textCustomFields": [
    {
      "configurationType": "string",
      "errorDetails": {
        "errorCode": "string",
        "message": "string"
      },
      "fieldId": "string",
      "name": "string",
      "required": "string",
      "show": "string",
      "value": "string"
    }
  ]
}

Retrieves the custom document field information from an existing template.

Authentication

Authorizationstring

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token>.

Path parameters

accountIdstringRequired

The external account number (int) or account id GUID.

templateIdstringRequired

The ID of the template being accessed.

Response

Successful response.

listCustomFieldslist of objectsOptional

An array of list custom fields.

textCustomFieldslist of objectsOptional

An array of text custom fields.

Errors

400

Bad Request Error