WorkspaceItems: listFolderItems

This method returns the contents of a workspace folder, which can include sub-folders and files.

Request

HTTP request

GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

folderIdstring

The id of the folder.

workspaceIdstring

The id of the workspace.

Optional Query Parameters
countstring

The maximum number of results to return.

include_filesstring

When set to true, the response includes file information (in addition to folder information). The default is false.

include_sub_foldersstring

When set to true, the response includes information about the sub-folders of the current folder. The default is false.

include_thumbnailsstring

When set to true, the response returns thumbnails. The default is false.

include_user_detailstring

When set to true, the response includes extended details about the user. The default is false.

start_positionstring

The position within the total result set from which to start returning values.

workspace_user_idstring

If set, the response only includes results associated with the userId that you specify.

Responses

CodeDescriptionReference
200

Successful response.

workspaceFolderContents
400

Error encountered.

errorDetails

SDK Method

Workspaces::listWorkspaceFolderItems

Definitions

errorDetails

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

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

page

Description of a page of a document.

dpistring

The number of dots per inch used for the page image.

errorDetailserrorDetails

If an error occurs, this property describes the error.

heightstring

The height of the page in pixels.

imageBytesstring

The number of image bytes.

mimeTypestring

The MIME type.

pageIdstring

The id of the page.

sequencestring

The sequence of the page in the document, or page number.

widthstring

The width of the page in pixels.

workspaceFolderContents

This object's properties describe the contents of a workspace folder.

endPositionstring

The last index position in the result set.

folderWorkspaceItems

The folder from which to return items. You can enter either the folder name or folder ID.

items[WorkspaceItems]

A list of workspace items.

parentFolders[WorkspaceItems]

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.

workspaceIdstring

The id of the workspace.

workspaceUser

This object represents the workspace user. This property is only returned in response to user specific GET call.

accountIdstring

The account ID associated with the workspace user.

accountNamestring

The name on the account.

activeSincestring

The UTC DateTime when the user joined the workspace.

createdstring

The UTC DateTime when the workspace user was created.

createdByIdstring

The id of the user who created this workspace user.

emailstring

The workspace user's email address.

errorDetailserrorDetails

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

invitationEmailBlurbstring

The text of the workspace invitation email message sent to the user.

invitationEmailSubjectstring

The subject line of the workspace invitation email message sent to the user.

lastModifiedstring

The UTC DateTime that the workspace user was last modified.

lastModifiedByIdstring

The id of the user who last modified the workspace user.

statusstring

Filters the results by user status. You can specify a comma-separated list of the following statuses:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

typestring

userIdstring

The id of the workspace user.

userNamestring

The name of workspace user.

workspaceIdstring

The id of the workspace.

workspaceUserBaseUrlstring

The URL for accessing the workspace user.

workspaceUserIdstring

The id of the workspace user.

workspaceUserUristring

The URI for accessing the workspace user.

workspaceUserAuthorization

Provides properties that describe user authorization to a workspace.

canDeletestring

When set to true, the workspace user can delete items from the workspace.

canMovestring

When set to true, the workspace user can move the items in the workspace.

canTransactstring

When set to true, the workspace user can create transactions from the workspace.

canViewstring

When set to true, the workspace user can view the items in the workspace.

createdstring

The UTC DateTime when the workspace user authorization was created.

createdByIdstring

The id of the user who created the workspace user authorization.

errorDetailserrorDetails

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

modifiedstring

The UTC DateTime when the workspace user authorization was last modified.

modifiedByIdstring

The id of the user who last modified the workspace user authorization.

workspaceUserIdstring

The id of the workspace user.

workspaceUserInformationworkspaceUser

An object that provides details about the workspace user.

WorkspaceItems

This object contains information about a file or folder in a workspace.

callerAuthorizationworkspaceUserAuthorization

An object that describes the caller's workspace permissions.

contentTypestring

If the item is a file, this property specifies the content type of the file.

createdstring

The UTC DateTime when the workspace item was created.

createdByIdstring

The id of the user who created the workspace item.

createdByInformationworkspaceUser

Details about the user who created the workspace item.

extensionstring

The file extension of a file item.

fileSizestring

The size of the file in bytes.

fileUristring

The URI for retrieving the file.

idstring

The id of the workspace item.

isPublicstring

When true, the item is public.

lastModifiedstring

The UTC DateTime that the item was last modified.

lastModifiedByIdstring

The id of the user who last modified the item.

lastModifiedByInformationworkspaceUser

Details about the user who last modified the workspace item.

namestring

The name of the file or folder.

pageCountstring

The number of pages in a file.

parentFolderIdstring

The id of the parent folder, or the special value root for the root folder.

parentFolderUristring

The URI of the parent folder.

sha256string

A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content of a file. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the upload is refused.

thumbHeightstring

The height of the thumbnail image.

thumbnailpage

thumbWidthstring

The width of the thumbnail image.

typestring

The type of workspace item. Valid values are:

  • file
  • folder

uristring

A URI containing the user ID.

userAuthorizationworkspaceUserAuthorization

An object that describes the user's workspace permissions.

Examples

Generic JSON Response

Response
{
  "workspaceId": "sample string 1",
  "parentFolders": [
    {
      "id": "sample string 1",
      "parentFolderId": "sample string 2",
      "parentFolderUri": "sample string 3",
      "name": "sample string 4",
      "type": "sample string 5",
      "uri": "sample string 6",
      "extension": "sample string 7",
      "contentType": "sample string 8",
      "pageCount": "sample string 9",
      "fileSize": "sample string 10",
      "fileUri": "sample string 11",
      "isPublic": "sample string 12",
      "callerAuthorization": {
        "workspaceUserId": "sample string 1",
        "workspaceUserInformation": {
          "workspaceUserId": "sample string 1",
          "status": "sample string 2",
          "type": "sample string 3",
          "workspaceId": "sample string 4",
          "accountId": "sample string 5",
          "userId": "sample string 6",
          "accountName": "sample string 7",
          "userName": "sample string 8",
          "email": "sample string 9",
          "workspaceUserBaseUrl": "sample string 10",
          "created": "sample string 11",
          "createdById": "sample string 12",
          "lastModified": "sample string 13",
          "lastModifiedById": "sample string 14",
          "activeSince": "sample string 15",
          "errorDetails": {
            "errorCode": "sample string 1",
            "message": "sample string 2"
          }
        },
        "canView": "sample string 2",
        "canTransact": "sample string 3",
        "canMove": "sample string 4",
        "canDelete": "sample string 5",
        "createdById": "sample string 6",
        "created": "sample string 7",
        "modifiedById": "sample string 8",
        "modified": "sample string 9",
        "errorDetails": {
          "errorCode": "",
          "message": ""
        }
      },
      "created": "sample string 13",
      "createdById": "sample string 14",
      "createdByInformation": {},
      "lastModified": "sample string 15",
      "lastModifiedById": "sample string 16",
      "lastModifiedByInformation": {}
    }
  ],
  "folder": {},
  "items": [
    {}
  ],
  "resultSetSize": "sample string 2",
  "startPosition": "sample string 3",
  "endPosition": "sample string 4",
  "totalSetSize": "sample string 5"
}
Generic XML Response

Response
<workspaceFolderContents xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <endPosition>sample string 4</endPosition>
  <folder />
  <items>
    <workspaceItem />
  </items>
  <parentFolders>
    <workspaceItem>
      <callerAuthorization>
        <canDelete>sample string 5</canDelete>
        <canMove>sample string 4</canMove>
        <canTransact>sample string 3</canTransact>
        <canView>sample string 2</canView>
        <created>sample string 7</created>
        <createdById>sample string 6</createdById>
        <errorDetails>
          <errorCode></errorCode>
          <message></message>
        </errorDetails>
        <modified>sample string 9</modified>
        <modifiedById>sample string 8</modifiedById>
        <workspaceUserId>sample string 1</workspaceUserId>
        <workspaceUserInformation>
          <accountId>sample string 5</accountId>
          <accountName>sample string 7</accountName>
          <activeSince>sample string 15</activeSince>
          <created>sample string 11</created>
          <createdById>sample string 12</createdById>
          <email>sample string 9</email>
          <errorDetails>
            <errorCode>sample string 1</errorCode>
            <message>sample string 2</message>
          </errorDetails>
          <lastModified>sample string 13</lastModified>
          <lastModifiedById>sample string 14</lastModifiedById>
          <status>sample string 2</status>
          <type>sample string 3</type>
          <userId>sample string 6</userId>
          <userName>sample string 8</userName>
          <workspaceId>sample string 4</workspaceId>
          <workspaceUserBaseUrl>sample string 10</workspaceUserBaseUrl>
          <workspaceUserId>sample string 1</workspaceUserId>
        </workspaceUserInformation>
      </callerAuthorization>
      <contentType>sample string 8</contentType>
      <created>sample string 13</created>
      <createdById>sample string 14</createdById>
      <createdByInformation />
      <extension>sample string 7</extension>
      <fileSize>sample string 10</fileSize>
      <fileUri>sample string 11</fileUri>
      <id>sample string 1</id>
      <isPublic>sample string 12</isPublic>
      <lastModified>sample string 15</lastModified>
      <lastModifiedById>sample string 16</lastModifiedById>
      <lastModifiedByInformation />
      <name>sample string 4</name>
      <pageCount>sample string 9</pageCount>
      <parentFolderId>sample string 2</parentFolderId>
      <parentFolderUri>sample string 3</parentFolderUri>
      <type>sample string 5</type>
      <uri>sample string 6</uri>
    </workspaceItem>
  </parentFolders>
  <resultSetSize>sample string 2</resultSetSize>
  <startPosition>sample string 3</startPosition>
  <totalSetSize>sample string 5</totalSetSize>
  <workspaceId>sample string 1</workspaceId>
</workspaceFolderContents> 
}} />