v2
latestOpenAPI 3.0.32026-07-31890635.1 KBEnvelope
Find envelopes
Find envelopes based on search criteria
get/envelope
Query parameters
querystring
The search query.
pagenumber
The pagination page number, starts at 1.
perPagenumber
The number of items per page.
type'DOCUMENT' | 'TEMPLATE'
Filter envelopes by type (DOCUMENT or TEMPLATE).
templateIdnumber
Filter envelopes by the template ID used to create it.
source'DOCUMENT' | 'TEMPLATE' | 'TEMPLATE_DIRECT_LINK'
Filter envelopes by how it was created.
status'DRAFT' | 'PENDING' | 'COMPLETED' | 'REJECTED' | 'CANCELLED'
Filter envelopes by the current status.
folderIdstring
Filter envelopes by folder ID.
orderByColumn'createdAt'
orderByDirection'asc' | 'desc'
Sort direction.
Response
Successful response