Envelopes

List envelopes (cursor pagination)

get/api/v1/envelopes

Request

  • Base URL: https://swiftsign.ca
  • URL: https://swiftsign.ca/api/v1/envelopes
  • Auth: HTTP bearer

Query parameters

cursorstring

Opaque cursor from next_cursor.

limitinteger

Default 25, max 100.

Example:25
status'DRAFT' | 'SENT' | 'COMPLETED' | 'DECLINED' | 'VOIDED'
mode'live' | 'test'

Defaults to the key’s mode.

created_afterstring

ISO 8601 lower bound.

created_beforestring

ISO 8601 upper bound.

recipient_emailstring email

Response

A page of envelopes.

has_moreboolean required
next_cursorstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.