Get custom document fields from template

GET

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

GET

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

curl https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/templates/TEMPLATE_ID/custom_fields \
     -H "Authorization: Bearer <apiKey>"

{
  "listCustomFields": [
    {
      "configurationType": "sample string 1",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "fieldId": "sample string 2",
      "listItems": [
        "sample string 1"
      ],
      "name": "sample string 3",
      "required": "sample string 4",
      "show": "sample string 5",
      "value": "sample string 6"
    }
  ],
  "textCustomFields": [
    {
      "configurationType": "sample string 1",
      "fieldId": "sample string 2",
      "name": "sample string 3",
      "required": "sample string 4",
      "show": "sample string 5",
      "value": "sample string 6"
    }
  ]
}

Retrieves the custom document field information from an existing template.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

The external account number (int) or account ID Guid.

templateIdstringRequired

The ID of the template.

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