Skip to main content
GET
List envelopes, newest first, optionally filtered by status or by your reference.

Authorizations

Authorization
string
header
required

Authorization: Bearer vsk_live_…. Chosen over a bespoke X-API-KEY header because every client, proxy and log-redaction rule already knows this one. What a key may DO is its scopes — see x-scopes at the root of this document and x-required-scope on each operation. The scope list is not written here because OpenAPI reserves a requirement’s scope array for oauth2 and openIdConnect and requires it to be empty for an http scheme.

Query Parameters

limit
integer
default:25

⚠️ A VALUE OUTSIDE THE RANGE IS REFUSED, NOT CLAMPED, for the same reason GET /api/v1/templates refuses one: a caller who asks for 1000 and receives 100 has a working integration reading their whole account in ten times the requests they budgeted, and nothing anywhere says so. How many envelopes to return.

Required range: 1 <= x <= 100
cursor
string<uuid>

The next_cursor from the previous page. Omit it to start at the newest envelope. Opaque — see above. An envelope id to resume after.

status
enum<string>

⚠️ AN UNKNOWN VALUE IS REFUSED, NOT ANSWERED WITH AN EMPTY PAGE. A typo — "complete" for "completed" — would otherwise read as "you have none", which is data-shaped and is exactly the failure this refusal exists to avoid. Omit it to list every status. Restrict the list to one status.

Available options:
draft,
sent,
partially_signed,
completed,
declined,
voided,
expired
reference
string

Only envelopes whose reference is exactly this — the one call that tells you whether a create whose answer you lost made anything. Compared in Unicode NFC, whichever form you send it in; case and whitespace are significant. Combines with status and cursor, and the matches are newest first like the rest of the list.

⚠️ MORE THAN ONE ROW CAN MATCH. A reference is not unique unless you made it so. ⚠️ AN EMPTY OR OVER-LONG VALUE IS REFUSED, NOT ANSWERED — an empty ?reference= is not "no filter", and a value no reference can be would otherwise answer "nothing was created". The reference you set on create: at most 255 UTF-16 code units once composed to NFC, as JavaScript counts string length: most characters count as one, some (outside the Basic Multilingual Plane, such as most emoji) count as two. No maxLength is declared, because JSON Schema counts code points and would admit a value the server refuses.

Minimum string length: 1
Example:

"hire-2026-0917"

Response

A page of envelope summaries, newest first, with the cursor for the next.

The page.

data
object[]
required

This page’s envelopes.

has_more
boolean
required

⚠️ THE ANSWER, rather than something to infer. A caller inferring "more" from a full page loops one extra time on every organisation whose envelope count is an exact multiple of limit.

next_cursor
string | null
required

Pass this as cursor for the next page. Null exactly when has_more is false -- the two are computed from one expression, so a true with a null cursor cannot happen. ⚠️ OPAQUE: it is the last envelope’s id, but that is an implementation detail rather than a promise -- pass it back exactly as received and never construct one by hand.