Skip to content

Folders.API

Nikhil Mashettiwar edited this page Jun 25, 2015 · 4 revisions

Namespace: Folders

Folders

Public API for DocuSign Folders API

Source:

Methods

<static> getEnvelopes(envelopeType, doFullRetrieval, callback)

Get information about envelopes for the account with the given apiToken.

Parameters:
Name Type Description
envelopeType string

The type of envelope to get. Valid values are 'all', 'awaiting_my_signature', 'out_for_signature', 'completed', and 'drafts'.

doFullRetrieval boolean

If true, retrieve all envelopes of the given envelopeType. Otherwise, only get the first 50 most recent envelopes.

callback function

Returns envelope info that is in response.folderItems.

Source:

<static> searchThroughEnvelopes(searchTerm, callback)

Search DS envelopes with the given searchTerm.

Parameters:
Name Type Description
searchTerm string

The term that the DS API should search for.

callback function

Returns the list of envelopes matching the search term.

Source:

Generated with wicked.