List envelopes

Authorizations

Authorization

string

header

required

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

Body

application/json

after

string

ascending

boolean

Whether to order envelopes in ascending order

before

string

comment

string

Comment of the envelope

date_from

integer

Unix timestamp of the start date

date_to

integer

Unix timestamp of the end date

first

integer

folder_ids

string[]

List of folder IDs

ids

string[]

List of envelope IDs

include_trash

boolean

Whether to include envelopes in the trash

last

integer

name

string

Name of the envelope

only_root_folder

boolean

Whether to only list envelopes in the root folder

order_field

enum<string>

Field to order envelopes by

Available options:

CREATION_DATE,

MODIFICATION_DATE,

NAME,

STATUS,

LAST_DOCUMENT_CHANGE

statuses

enum<string>[]

List of envelope statuses

Available options:

DRAFT,

IN_PROGRESS,

COMPLETED,

EXPIRED,

DECLINED,

VOIDED,

PENDING

Response

200 - application/json

envelopes

object[]

envelopes.comment

string

Comment for the envelope

envelopes.created_at

integer

Unix timestamp of the creation date

envelopes.documents

object[]

envelopes.expires_at

integer

Unix timestamp of the expiration date

envelopes.flow_type

enum<string>

Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)

Available options:

REQUEST_SIGNATURE,

SIGN_MYSELF

envelopes.id

string

Unique identifier of the envelope

envelopes.is_duplicable

boolean

Whether the envelope can be duplicated

envelopes.legality_level

enum<string>

Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)

Available options:

SES,

QES_EIDAS,

QES_ZERTES

envelopes.name

string

Name of the envelope

envelopes.notification

object

envelopes.num_recipients

integer

Number of recipients in the envelope

envelopes.pages

integer

Total number of pages in the envelope

envelopes.signing_steps

object[]

envelopes.status

enum<string>

Status of the envelope

Available options:

DRAFT,

IN_PROGRESS,

COMPLETED,

EXPIRED,

DECLINED,

VOIDED,

PENDING

envelopes.updated_at

integer

Unix timestamp of the last modification date

has_next_page

boolean

Whether there is a next page

has_previous_page

boolean

Whether there is a previous page

Get Started

Concepts

Guides

Backend SDKs

API Reference

Authorizations

Body

Response