Sign in

v1

latestOpenAPI 3.0.02026-07-24176123205.3 KB
ESignature Packages

List all eSignature packages

Returns a list of objects. The objects are turned sorted by the updated date, with the most recently created appearing first.

get/e-signature-packages

Query parameters

limitnumber

Limit on number of objects returned. Default to 100. Maximum 100.

skipnumber

The cursor pagination for the number at which at the returned array starts. Must be less than maximum of elements.

kind'IN_PERSON' | 'LIVE' | 'STANDARD'

Filter packages by kind if provided

isENotaryboolean

If provided, will apply a filter to include (i.e. true) or exclude (i.e false) eNotary packages (i.e. IPEN or RON)

excludeBulkSentPackageboolean

Determines whether to include eSignature packages that are part of a bulk send package

searchTermstring

Text to search for eSignature packages

sortBy'updatedAt' | '_updatedAt' | 'title' | '_title' | 'status' | '_title' | 'schedulingDetails.date' | '_schedulingDetails.date'

sort by value. If starts with _, it will be sorted in descending order

updatedAtStartDatestring date-time

Filter packages updated on or after the specified date

updatedAtEndDatestring date-time

Filter packages updated on or before the specified date

statusesESignatureStatusEnum[]

Filter packages by status

packageFolderIdsstring[]

Package folders that owner has write or admin access to

packageFolderStatusesPackageFolderStatusEnum[]

Filter packages by folder status (i.e. ACTIVE, ARCHIVED)

Response

A directory with a data property that contains an array of up to limit objects, starting after skip. Each entry in the array is a separate object. If no more objects are available, the resulting array will be empty. This request should never return an error.

hasMoreboolean
All 176 operations