DocuSign Momentum 2018DocuSign Momentum 2018
{"api":"esign_rest","category":"reference"}

Folders Resource

The Folders resource provides methods that allow you to view contents of folders on the account and move envelopes between folders.

MethodDescription
list
GET /v2/accounts/{accountId}/folders

Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the template query string parameter.

listItems
GET /v2/accounts/{accountId}/folders/{folderId}

Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.

moveEnvelopes
PUT /v2/accounts/{accountId}/folders/{folderId}

Moves an envelope from its current folder to the specified folder.

Note: You can use this endpoint to delete envelopes by specifying recyclebin in the folderId parameter of the endpoint. Placing an in process envelope (envelope status of sent or delivered) in the recycle bin voids the envelope. You can also use this endpoint to delete templates by specifying a template ID instead of an envelope ID in the 'envelopeIds' property and specifying recyclebin in the folderId parameter.

search
GET /v2/accounts/{accountId}/search_folders/{searchFolderId}

Retrieves a list of envelopes that match the criteria specified in the query.

If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.