DocuSign icon

DocuSign

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

Actions341

Envelope Lock → Get

AI-generated

Summary

Retrieve the lock information for a specified envelope.

Inputs

  • authentication — Authentication method (OAuth2 or JWT Service Integration).
  • category — API category selector; default is Envelopes.
  • accountId (required) — DocuSign Account ID (GUID).
  • envelopeId (required) — ID (GUID) of the envelope to retrieve the lock for.

Output shape

a single envelope lock record

Returns a JSON object containing lock details; errors are signaled by HTTP status and DocuSign error payload.

Examples

Example 1: Get lock for an envelope using OAuth2 authentication

authentication: OAuth2, accountId: 12345678-90ab-cdef-1234-567890abcdef, envelopeId: a1b2c3d4-ef56-7890-abcd-1234567890ab

Example 2: Get lock for an envelope using JWT authentication

authentication: JWT, accountId: 12345678-90ab-cdef-1234-567890abcdef, envelopeId: a1b2c3d4-ef56-7890-abcd-1234567890ab

Example 3: Get lock for an envelope using default category

category: envelopes, authentication: OAuth2, accountId: 12345678-90ab-cdef-1234-567890abcdef, envelopeId: a1b2c3d4-ef56-7890-abcd-1234567890ab

Links

Discussion