EnvelopeShares

GET /v2.1/accounts/{accountId}/envelopes/shared

Changed on

Request

  • Base URL
    https://www.docusign.net/restapi
  • Auth
    none declared

Path parameters

accountIdstring required

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

Query parameters

countstring

The maximum number of results to return.

from_datestring

The start date for a date range in UTC DateTime format.

Note: If this property is null, no date filtering is applied.

includestring
orderstring

The order in which to sort the results.

Valid values are:

  • asc: Ascending order.
  • desc: Descending order.
order_bystring

The file attribute to use to sort the results.

Valid values are:

  • modified
  • name
search_textstring

Use this parameter to search for specific text.

start_positionstring

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

statusstring

The status of the item.

to_datestring

The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.

Note: If this property is null, the value defaults to the current date.

Response

Successful response.

continuationTokenstring

Reserved for Docusign.

endPositionstring

The last index position in the result set.

envelopeSearchSourcestring
lastQueriedDateTimestring

The last time that a query was performed.

nextUristring

The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.

previousUristring

The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.

resultSetSizestring

The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.

startPositionstring

The starting index position of the current result set.

totalSetSizestring

The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.

Changes