get
POST /public/envelope/get
Retrieves an envelope by UUID. The response includes metadata, documents, attachments, signing and approval metrics, tags, and the list of participants (recipients) with their roles and status.
Request Body required
Section titled “Request Body required ”object
Optional. When omitted, the team’s default workspace is used.
The UUID of the envelope to get.
Responses
Section titled “ Responses ”Default Response
object
The unique identifier of the envelope.
The title of the envelope.
The status of the envelope.
The date and time the envelope was created (unix timestamp).
The date and time the envelope was last updated (unix timestamp).
Information about the sender of the envelope.
object
The email address of the sender.
The display name of the sender.
The list of documents in the envelope.
object
The unique identifier of the document.
The title of the document.
The blocks content of the document organized by page number.
object
object
object
object
object
object
object
object
object
object
object
object
The date and time the document snapshot was last updated (unix timestamp).
Whether signatures are placed on a separate page from the document content.
Whether initials are required on all pages of the document.
Whether the signer must read all pages before signing.
The number of pages in the document.
The list of attachments in the envelope.
object
The unique identifier of the attachment.
The title of the attachment.
The tags of the envelope.
object
The number of signatures on the envelope.
The number of signatures required on the envelope.
The number of approvals on the envelope.
The number of approvals required on the envelope.
Whether signature order is enabled for this envelope.
Whether to use the user’s name (true) or team name (false) as sender in invitation emails.
Number of days until expiration of the recipient link invitation (min: 1, max: 90).
Participants on this envelope (signers, approvers, and viewers), including contact fields, role, routing order, completion status, and invitation metadata when applicable.
object
Recipient email address.
Recipient first name.
Recipient last name.
Recipient phone number.
Recipient job title.
Recipient company name.
Recipient primary address line.
Recipient secondary address line.
Recipient postal or ZIP code.
Recipient city.
Recipient country.
Recipient role in the envelope workflow.
Recipient routing order in sequential workflows.
Whether this recipient is linked to an existing contact.
Current recipient completion status.
Recipient language preference.
Default verification type for this participant on the envelope; it is the configuration applied when creating or refreshing invitations and links.
Metadata for the recipient’s current valid invitation link, when one exists.
object
Whether the recipient invitation link is currently valid.
Invitation link expiration timestamp (unix timestamp).
Invitation link creation timestamp (unix timestamp).
How the invitation is delivered (opaque application-specific value, e.g. email or webhook channel name).
Verification mode stored on the active invitation link (snapshot from when the link was issued). May differ from the recipient’s top-level verificationType if the participant configuration was updated afterward.
Default Response
object
HTTP status code
object
The error code
The error message
A suggestion to resolve the error
A URL to the documentation
Optional validation details (e.g. for INVALID_REQUEST_FORMAT)
Single validation issue (e.g. from request body schema)
object
JSON path to the invalid field
Validation error message for this field
The unique identifier of the request
The timestamp of the response
The path of the request
Default Response
object
HTTP status code
object
The error code
The error message
A suggestion to resolve the error
A URL to the documentation
Optional validation details (e.g. for INVALID_REQUEST_FORMAT)
Single validation issue (e.g. from request body schema)
object
JSON path to the invalid field
Validation error message for this field
The unique identifier of the request
The timestamp of the response
The path of the request
Default Response
object
HTTP status code
object
The error code
The error message
A suggestion to resolve the error
A URL to the documentation
Optional validation details (e.g. for INVALID_REQUEST_FORMAT)
Single validation issue (e.g. from request body schema)
object
JSON path to the invalid field
Validation error message for this field
The unique identifier of the request
The timestamp of the response
The path of the request
Default Response
object
HTTP status code
object
The error code
The error message
A suggestion to resolve the error
A URL to the documentation
Optional validation details (e.g. for INVALID_REQUEST_FORMAT)
Single validation issue (e.g. from request body schema)
object
JSON path to the invalid field
Validation error message for this field
The unique identifier of the request
The timestamp of the response
The path of the request