Folders: list

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.

Request

HTTP request

GET /v2/accounts/{accountId}/folders

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Optional Query Parameters
includestring

Reserved for DocuSign.

start_positionstring

Reserved for DocuSign.

templatestring

Specifies the items that are returned. Valid values are:

  • include - The folder list will return normal folders plus template folders.
  • only - Only the list of template folders are returned.

user_filterstring

Reserved for DocuSign.

Responses

CodeDescriptionReference
200

Successful response.

Folders
400

Error encountered.

errorDetails

SDK Method

Folders::list

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

An error code associated with the error.

messagestring

A short error message.

filter

actionRequiredstring

Action required.

expiresstring

folderIdsstring

fromDateTimestring

isTemplatestring

orderstring

An optional value that sets the direction order used to sort the item list.

Valid values are:

  • asc = ascending sort order
  • desc = descending sort order

orderBystring

searchTargetstring

searchTextstring

statusstring

Filter status.

toDateTimestring

Latest date to filter.

folder

errorDetailserrorDetails

filterfilter

folderIdstring

The ID of the folder being accessed.

folders[folder]

A collection of folder objects returned in a response.

namestring

ownerEmailstring

ownerUserIdstring

ownerUserNamestring

parentFolderIdstring

parentFolderUristring

typestring

Type of the user. Valid values: type_owner, type_participant.

uristring

Folders

Folder management

folders[folder]

A collection of folder objects returned in a response.

Examples

Generic JSON Response

Response
{
  "folders": [
    {
      "ownerUserName": "sample string 1",
      "ownerEmail": "sample string 2",
      "ownerUserId": "sample string 3",
      "type": "sample string 4",
      "name": "sample string 5",
      "uri": "sample string 6",
      "parentFolderId": "sample string 7",
      "parentFolderUri": "sample string 8",
      "folderId": "sample string 9",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "folders": [
        {}
      ],
      "filter": {
        "actionRequired": "sample string 1",
        "expires": "sample string 2",
        "isTemplate": "sample string 3",
        "status": "sample string 4",
        "fromDateTime": "sample string 5",
        "toDateTime": "sample string 6",
        "searchTarget": "sample string 7",
        "searchText": "sample string 8",
        "folderIds": "sample string 9",
        "orderBy": "sample string 10",
        "order": "sample string 11"
      }
    }
  ]
}
Generic XML Response

Response
<foldersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <folders>
    <folder>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <filter>
        <actionRequired>sample string 1</actionRequired>
        <expires>sample string 2</expires>
        <folderIds>sample string 9</folderIds>
        <fromDateTime>sample string 5</fromDateTime>
        <isTemplate>sample string 3</isTemplate>
        <order>sample string 11</order>
        <orderBy>sample string 10</orderBy>
        <searchTarget>sample string 7</searchTarget>
        <searchText>sample string 8</searchText>
        <status>sample string 4</status>
        <toDateTime>sample string 6</toDateTime>
      </filter>
      <folderId>sample string 9</folderId>
      <folders>
        <folder />
      </folders>
      <name>sample string 5</name>
      <ownerEmail>sample string 2</ownerEmail>
      <ownerUserId>sample string 3</ownerUserId>
      <ownerUserName>sample string 1</ownerUserName>
      <parentFolderId>sample string 7</parentFolderId>
      <parentFolderUri>sample string 8</parentFolderUri>
      <type>sample string 4</type>
      <uri>sample string 6</uri>
    </folder>
  </folders>
</foldersResponse> 
}} />