List Envelopes

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Query parameters

statusstringOptional

Optional: Filter by envelope status - in: PENDING|DISPATCHED|IN_PROGRESS|COMPLETED|EXPIRED|REVOKED|DECLINED

document_idstringOptional

Optional: Filter by document UUID - exists:documents,id

parent_record_typestringOptional

Optional: Polymorphic parent alias

parent_record_idstringOptional

Optional: Parent record UUID

created_afterstringOptional

Optional: Lower bound on created_at - date format

created_beforestringOptional

Optional: Upper bound on created_at - date format

pageintegerOptional

Optional: Page number

per_pageintegerOptional

Optional: Results per page - integer 1-200

Response

Successful response