DocuSign icon

DocuSign

Interact with the DocuSign eSignature REST API v2.1 — complete enterprise coverage

Actions341

Document Generation → Get Form Fields

AI-generated

Summary

Retrieve form field definitions for a specified envelope within a chosen DocuSign category.

Inputs

  • authentication — Authentication method (OAuth2 or JWT Service Integration).
  • category — API category to query (e.g., envelopes, templates). Defaults to envelopes.
  • accountId (required) — The DocuSign Account ID (GUID).
  • envelopeId (required) — The ID (GUID) of the envelope whose form fields to retrieve.

Output shape

a list of form field definitions

Each definition includes field type, required flag, anchor strings, etc.; some fields may be omitted; errors follow standard envelope error format.

Examples

Example 1: Get form fields for envelope 12345678-90ab-cdef-1234-567890abcdef in the envelopes category using default OAuth2 authentication.

Authentication: OAuth2; Category: envelopes; Account ID: 11111111-2222-3333-4444-555555555555; Envelope ID: 12345678-90ab-cdef-1234-567890abcdef

Example 2: Fetch form fields for a template using JWT service integration.

Authentication: jwt; Category: templates; Account ID: 11111111-2222-3333-4444-555555555555; Envelope ID: abcdef12-3456-7890-abcd-ef1234567890

Links

Discussion