/
DO
documenso
/
Documenso v2 API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 9h ago · Updated 4w ago
Details
Filter operations
Document
16
Document Fields
6
Document Recipients
6
Embedding
2
Envelope
14
get
Find envelopes
get
Get envelope audit logs
get
Download envelope audit log PDF
get
Download envelope certificate PDF
get
Get envelope
post
Get multiple envelopes
post
Create envelope
post
Use envelope
post
Update envelope
post
Delete envelope
post
Cancel envelope
post
Duplicate envelope
post
Distribute envelope
post
Redistribute envelope
Envelope Attachments
4
Envelope Fields
4
Envelope Items
4
Envelope Recipients
5
Folder
4
Template
12
Template Fields
6
Template Recipients
6
Envelope
Get envelope
Returns an envelope given an ID
get
/envelope/{envelopeId}
Path parameters
envelopeId
string
required
Response
Successful response
object
required
internalVersion
number
required
type
'DOCUMENT'
|
'TEMPLATE'
required
status
'DRAFT'
|
'PENDING'
|
'COMPLETED'
|
'REJECTED'
|
'CANCELLED'
required
source
'DOCUMENT'
|
'TEMPLATE'
|
'TEMPLATE_DIRECT_LINK'
required
visibility
'EVERYONE'
|
'MANAGER_AND_ABOVE'
|
'ADMIN'
required
templateType
'PUBLIC'
|
'PRIVATE'
|
'ORGANISATION'
required
id
string
required
secondaryId
string
required
externalId
string
nullable
required
createdAt
string
required
updatedAt
string
required
completedAt
string
nullable
required
deletedAt
string
nullable
required
title
string
required
authOptions
object
nullable
required
formValues
object
nullable
required
publicTitle
string
required
publicDescription
string
required
userId
number
required
teamId
number
required
folderId
string
nullable
required
templateId
number
nullable
required
documentMeta
object
required
recipients
object[]
required
fields
object[]
required
envelopeItems
object[]
required
directLink
object
nullable
required
team
object
required
user
object
required
Changes