POST
/
envelopes

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string

Name of the envelope

tags
string[]

List of tags

comment
string

Comment of the envelope

ids
string[]

List of envelope IDs

statuses
enum<string>[]

List of envelope statuses

Available options:
DRAFT,
IN_PROGRESS,
COMPLETED,
EXPIRED,
DECLINED,
VOIDED,
PENDING
folder_ids
string[]

List of folder IDs

only_root_folder
boolean

Whether to only list envelopes in the root folder

date_from
integer

Unix timestamp of the start date

date_to
integer

Unix timestamp of the end date

uid
string

Unique identifier of the user

first
integer
last
integer
after
string
before
string
order_field
enum<string>

Field to order envelopes by

Available options:
CREATION_DATE,
MODIFICATION_DATE,
NAME,
STATUS,
LAST_DOCUMENT_CHANGE
ascending
boolean

Whether to order envelopes in ascending order

include_trash
boolean

Whether to include envelopes in the trash

Response

200 - application/json
has_next_page
boolean

Whether there is a next page

has_previous_page
boolean

Whether there is a previous page

envelopes
object[]
Create new envelope from templateGet envelope