DocuSign icon

DocuSign

Send documents for eSignature and manage envelopes with DocuSign

Actions198

Envelope Custom Field → Get

AI-generated

Summary

Retrieves the custom fields (text and list metadata fields) attached to a single DocuSign envelope, identified by its envelope ID.

Inputs

  • authentication — Credential type used for the request: JWT (Service Integration, default) or OAuth2 (User Authorization).
  • envelopeId (required) — The ID of the envelope whose custom fields should be fetched.

Output shape

The DocuSign API response for the envelope's custom fields, returned as a single item. This is typically an object with textCustomFields and listCustomFields arrays.

The source pack shows only the handler name (handleEnvelopeCustomFieldGet), not its body, so the exact endpoint and response shape are inferred from DocuSign's API. An envelope with no custom fields likely returns empty arrays. Invalid or unknown envelope IDs produce an API error.

Examples

Example 1: Read an envelope's custom metadata, such as a CRM record ID, after it completes.

Resource: Envelope Custom Field; Operation: Get; Envelope ID set by expression from a previous DocuSign node, e.g. {{ $json.envelopeId }}.

Example 2: Check existing custom fields before updating or deleting one.

Resource: Envelope Custom Field; Operation: Get; Envelope ID: a fixed envelope ID; Authentication: JWT.

Links

Discussion