Skip to content
Subnoto Logo Subnoto Documentation

get

POST
/public/envelope/get

Get an envelope by UUID. Returns envelope details, documents, and metrics.

Request Body required

Section titled “Request Body required ”
object
workspaceUuid
required

The UUID of the workspace to get the envelope from.

string
>= 36 characters <= 36 characters
envelopeUuid
required

The UUID of the envelope to get.

string
>= 36 characters <= 36 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

object
uuid
required

The unique identifier of the envelope.

string
title
required

The title of the envelope.

string
<= 255 characters
status
required

The status of the envelope.

string
Allowed values: uploading draft approving signing complete declined canceled
creationDate
required

The date and time the envelope was created (unix timestamp).

number
updateDate
required

The date and time the envelope was last updated (unix timestamp).

number
sentDate
required
Any of:
number
owner
required

The creator of the envelope.

object
uuid
required

The unique identifier of the owner.

string
email
required

The email of the owner.

string
firstname
Any of:
string
lastname
Any of:
string
sender
required

Information about the sender of the envelope.

object
email
required

The email address of the sender.

string
name
required

The display name of the sender.

string
documents
required

The list of documents in the envelope.

Array<object>
object
uuid
required

The unique identifier of the document.

string
title
required

The title of the document.

string
<= 255 characters
blocks
required

The blocks content of the document organized by page number.

object
key
additional properties
Array
Any of:
object
uuid
required
string
label
required
string
labelIcon
string
Allowed values: at text-t image signature user
x
required
number
y
required
number
height
number
width
number
exportable
required
boolean
recipientEmail
string
exported
boolean
color
string
Allowed values: primary info auxiliary success warning danger
recipientLabel
string
type
required
string
Allowed values: text
text
required
string
templatedText
string
Allowed values: email fullname phone
editable
boolean
snapshotDate

The date and time the document snapshot was last updated (unix timestamp).

number
signaturesOnSeparatePage
required

Whether signatures are placed on a separate page from the document content.

boolean
initialsOnAllPages
required

Whether initials are required on all pages of the document.

boolean
pageCount
required

The number of pages in the document.

number
tags
required

The tags of the envelope.

Array<string>
0
metrics
required
object
signatureCount
required

The number of signatures on the envelope.

number
signatureRequiredCount
required

The number of signatures required on the envelope.

number
approvalCount
required

The number of approvals on the envelope.

number
approvalRequiredCount
required

The number of approvals required on the envelope.

number

400

Section titled “400 ”

Default Response

object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: WORKSPACE_NOT_FOUND ENVELOPE_NOT_FOUND INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string

401

Section titled “401 ”

Default Response

object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: AUTHENTICATION_ERROR TUNNEL_ERROR INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string

403

Section titled “403 ”

Default Response

object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: AUTHORIZATION_ERROR FEATURE_NOT_IN_CURRENT_PLAN INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string

500

Section titled “500 ”

Default Response

object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: INTERNAL_SERVER_ERROR INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string