DocuSign Momentum 2018DocuSign Momentum 2018

Folders: listItems

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

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

folderIdstring

The ID of the folder being accessed.

Optional Query Parameters
from_datestring

Only return items on or after this date. If no value is provided, the default search is the previous 30 days.

owner_emailstring

The email of the folder owner.

owner_namestring

The name of the folder owner.

search_textstring

The search text used to search the items of the envelope. The search looks at recipient names and emails, envelope custom fields, sender name, and subject.

start_positionstring

The position of the folder items to return. This is used for repeated calls, when the number of envelopes returned is too much for one return (calls return 100 envelopes at a time). The default value is 0.

statusstring

The current status of the envelope. If no value is provided, the default search is all/any status.

to_datestring

Only return items up to this date. If no value is provided, the default search is to the current date.

Responses

CodeDescriptionReference
200

Successful response.

folderItemsResponse
400

Error encountered.

errorDetails

SDK Method

Folders::listItems

Definitions

customField_v2
errorDetails
folderItem
folderItemsResponse

Examples

Generic JSON Response
Generic XML Response