Skip to content

List Envelopes

GET
/envelopes

Envelopes in the organisation, newest first.

source_type + source_id is the join back to whatever produced the envelope, so “has the quote I sent been signed” is one call rather than a scan.

Authorizations

Parameters

Query Parameters

status
Any of:
string

draft, sent, viewed, completed, voided, expired.

source_type
Any of:
string

What produced the envelope, e.g. quote.

source_id
Any of:
string

The producing record’s id.

page
integer
default: 1 >= 1
limit
integer
default: 50 >= 1 <= 100

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

A page of envelopes.

object
items
Array
limit
integer
default: 50
page
integer
default: 1
total
integer
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string