Retrieves the custom document field information from an existing envelope document.

Request

HTTP request

GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

documentIdstring

The ID of the document being accessed.

envelopeIdstring

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeDocumentFields
400

Error encountered.

errorDetails

SDK Method

Envelopes::listDocumentFields

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

An error code associated with the error.

messagestring

A short error message.

nameValue

errorDetailserrorDetails

namestring

The name or key of a name/value pair.

originalValuestring

The initial value of the tab when it was sent to the recipient.

valuestring

The value field of a name/value pair.

EnvelopeDocumentFields

Envelope document fields

documentFields[nameValue]

The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements:

  • name - A string that can be a maximum of 50 characters.
  • value - A string that can be a maximum of 200 characters.

IMPORTANT: If you are using xml, the name/value pair is contained in a nameValue element.

Examples

Generic JSON Response

Response
{
  "documentFields": [
    {}
  ]
}
Generic XML Response

Response
<documentFieldsInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <documentFields>
    <nameValue />
  </documentFields>
</documentFieldsInformation> 
}} />