Gets the custom field information for the specified envelope

Server URLloading...

GET

/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Send

Authorization

Path

Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the Docusign member console. The envelope custom fields are not seen by the envelope recipients.

There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.

Related topics

• How to get envelope custom tab values

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

curl -X GET "https://example.com/v2.1/accounts/string/envelopes/string/custom_fields"

{  "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"    }  ]}